Skip to main content

Flake8 plugin for prometheus metric name validation

Project description

Flake8 prometheus metric name plugin

pypi Python: 3.6+ License: MIT Code style: black

Flake8 plugin to check metrics name prefix for official client


pip install flake8-prometheus-metrics-name


Imagine we have python module

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:

prometheus-metrics-name-prefixes =

Run flake8 flake8 cause following warnings: PRM902: Metric name should start with one of following prefixes: "kek_", "lol_", got "some_name1" instead 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:

prometheus-metrics-disabled = 1

then AST nodes will not be analized for metrics name on flake8 run.



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-prometheus-metrics-name-0.1.9.tar.gz (4.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page