Flake8 plugin for prometheus metric name validation
Project description
Flake8 prometheus metric name plugin
Flake8 plugin to check metrics name prefix for official client https://github.com/prometheus/client_python.
Installation
pip install flake8-prometheus-metrics-name
Usage
Imagine we have python module some_module.py
:
from prometheus_client import Counter
Counter(name='kek_values', documentation='some doc')
Counter(name='some_name1', documentation='some doc')
Counter(name='some_name2', documentation='some doc') # noqa: PRM902
Counter(name='some_name3', documentation='some doc')
Counter(name='lol_values', documentation='some doc')
Add valid metrics name prefixes to setup.cfg
:
[flake8]
prometheus-metrics-name-prefixes =
kek_
lol_
Run flake8 flake8 some_modue.py
cause following warnings:
some_module.py:4:1: PRM902: Metric name should start with one of following prefixes: "kek_", "lol_", got "some_name1" instead
some_module.py:6:1: PRM902: Metric name should start with one of following prefixes: "kek_", "lol_", got "some_name3" instead
Plugin also may be disabled by adding following option to setup.cfg
:
[flake8]
prometheus-metrics-disabled = 1
then AST nodes will not be analized for metrics name on flake8 run.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for flake8_prometheus_metrics_name-0.1.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f032b9f966aa745fa805261b1fa411b46257ce083216848f1a84eebbd9d7b8bd |
|
MD5 | 7aaaaead0865032f5e60dc4b0fb417e5 |
|
BLAKE2b-256 | ec794fa09345441bf0aa8695abaeb176d9809c4b4401dedddd1abc513433ad3e |
Close
Hashes for flake8_prometheus_metrics_name-0.1.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdc8ab18b9ea36e4cfcd122961b5a75168f75a6615e1f22932a294345d246dbb |
|
MD5 | f6e14a0c5085e03680dfdeb7a99ecfb5 |
|
BLAKE2b-256 | 7af7b192e5835ceeb886f7e4ccfe942db3f645b45b62f770c6f6ae2fad7ee542 |