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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5cbc6e6ca76c82a5773bc94f1a1b1ce1b037ae9ccb7d2bef0dcbf47b675d4eb |
|
MD5 | a9958d152717c468ae9cfab11e1d62f0 |
|
BLAKE2b-256 | d1f34cc82b109e815f044f42398496d653dadf2feecd31c2142cd6e6a4d0647b |
Close
Hashes for flake8_prometheus_metrics_name-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3a891c923efc6d6762de4458f073006c497fca237d106c086260416a683ac1d |
|
MD5 | dad3b9f2ed07371f3801e5ba2eda4512 |
|
BLAKE2b-256 | 4be713ea1b527c3c2e5cc576e7455a0e14f2e6dce3ba573d558d65cd0eb8ec58 |