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
```bash
pip install flake8-prometheus-metrics-name
```
## Usage
Imagine we have python module `some_module.py`:
```python
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`:
```buildoutcfg
[flake8]
prometheus-metrics-name-prefixes =
kek_
lol_
```
Run flake8 `flake8 some_modue.py` cause following warnings:
```bash
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`:
```buildoutcfg
[flake8]
prometheus-metrics-disabled = 1
```
then AST nodes will not be analized for metrics name on flake8 run.
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af9622d2c1dbbe1960c6bb066337e225b4e62da47d81a3416cc19c24f80f94ad |
|
MD5 | 909ea7ceb395c7225cb69f0d16483e6d |
|
BLAKE2b-256 | db34ea265e9c5ee46aa9834080e784afd44772bd4f758658c52a43342e808b09 |
Close
Hashes for flake8_prometheus_metrics_name-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb836f642b9ae1d19fd48993453149604bd10d4b7f61163f7b69ca7977d5cb14 |
|
MD5 | 64edd472ec1ce977794065bc8b2b7983 |
|
BLAKE2b-256 | 1f9a4621603a4dc5f0d95e87e80156b3e7b3e0c1e23010da45e6a59f9169dd6b |