Django Prometheus business metrics

This Django app provides a Prometheus metrics endpoint serving so-called business metrics. These are metrics that are calculated when Prometheus hits the metrics endpoint.

Usage

This project uses ApiVer. Always import from django_business_metrics.v0 namespace and not from django_business_metrics.

1. Create a BusinessMetricsManager object and register some metrics:

   # project/business_metrics.py
   
   from django_business_metrics.v0 import BusinessMetricsManager, users
   
   metrics_manager = BusinessMetricsManager()
   
   # Add a pre-defined metric
   metrics_manager.add(users)
   
   # Add some custom metrics
   @metrics_manager.metric(name='name', documentation='documentation')
   def my_metric():
       return 10
   

2. Register a Prometheus endpoint:

   # project/urls.py
   
   ...
   from .business_metrics import metrics_manager
   
   ...
   urlpatterns = [
       ...
       path('business-metrics', metrics_manager.view),
       ...
   ]
   

3. Setup your Prometheus agent to scrape metrics from /business-metrics endpoint.

Development

Pre-requisites:

• pdm
• nox
• docker and docker composep plugin

Ideally, you should run nox -s format lint before every commit to ensure that the code is properly formatted and linted. Before submitting a PR, make sure that tests pass as well, you can do so using:

nox -s format lint test

If you wish to install dependencies into .venv so your IDE can pick them up, you can do so using:

pdm install --dev

Release process

Run nox -s make_release -- X.Y.Z where X.Y.Z is the version you're releasing and follow the printed instructions.