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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af4072ddf28b2b502eeb4eb4b065de87282b4b7e4a62f0ce22b37e1d6b5b914d |
|
MD5 | e12784ce6d3007ab5090cdddaebdd1ec |
|
BLAKE2b-256 | 3ac4b901898373469a6ad16efd48cfa9dcdfa32cbabefeb1f98270987a9ea7ca |
Close
Hashes for flake8_prometheus_metrics_name-0.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34bf3f7e18e49eca71eeaffdb74bc62842420c43df2344ace62e433f73347646 |
|
MD5 | cd316c630982ece48ec7d1462a0e30bb |
|
BLAKE2b-256 | bcae467dc57e12a0c954031fb5feb72cbbfe23e29d96ce452e5f7cbf065cd133 |