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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d7b006847571379cd18e5e9dd5443c38e334544a5a8c79a736d036e1834e0b9 |
|
MD5 | 5123ef997bc7666695609d4869b3cd40 |
|
BLAKE2b-256 | 0cc5f9c46a957ed55ad91c1ac5d6b90319ee29ae30b7cfcdea9c453c744dcff8 |
Close
Hashes for flake8_prometheus_metrics_name-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c337f6c53e5ea41967bf06e617bcab1f293afdf9320619fce4838ebeb93275d |
|
MD5 | 578c2a12bb5415857f240b565def2023 |
|
BLAKE2b-256 | f7af3af775a43e3af561b8581da68c7b4028f43c3b90cf2ba30cb023da86f840 |