django-aetos 0.3.0

Export Django monitoring metrics for prometheus.io

A Django app to expose metrics to be scraped by prometheus.io.

Usage

First, install django-aetos:

pip install django-aetos

then, add the app to settings.py:

INSTALLED_APPS = [
    # ... other apps ...
    "django_aetos",
    # ... other apps ...
]

configure aetos in settings.py:

> ℹ️ Important: When using django-aetos in a project behind a reverse proxy, include [django-xff](https://pypi.org/project/django-xff/) in your project, so that a request’s REMOTE_ADDR header gets rewritten to the correct client ip.

# on enabled ip allowlist with empty list, requests are denied
AETOS_ENABLE_IP_ALLOWLIST = True
AETOS_IP_ALLOWLIST = ["127.0.0.1"]

# enables authentication via bearer token
# if enabled with empty list, requests are denied
AETOS_ENABLE_AUTH = True
AETOS_AUTH_TOKENS = ["ooy9Evuth0zahka"]

and send requests to /metrics to Aetos in your urls.py:

from django.urls import include

urlpatterns = [
    path("", include("django_aetos.urls")),
    # ... your other patterns ...
]

Then, add your own metrics by listening for the collect_metrics signal. Refer to [the django docs](https://docs.djangoproject.com/en/dev/topics/signals/) on details how to do this.

Your signal handler can return multiple metrics, each represented as a dict within a list of generator.

Your src/app/signals.py:

from django.dispatch import receiver

from django_aetos.signals import collect_metrics


@receiver(collect_metrics, dispatch_uid='metric_universes_count')
def metric_universes_count(sender, **kwargs):
    yield {
        "name": "universes_count",
        "help": "Total number of universes",
        "type": "counter",
        "value": 1,
    }

You can do anything you like here, like make database queries or look at files in the filesystem.

To make sure your receiver actually connects, add an import to your src/app/apps.py:

from django.apps import AppConfig

class YourAppConfig(AppConfig):
    name = "yourapp"

    def ready(self):
        from . import signals  # NOQA

Dev Setup

python3 -m venv venv
source venv/bin/activate
make setup
make install-dev

Testing

make test

Packaging

git pull
make bump-version part=minor
git push origin main v$(bump-my-version show current_version)

make build
make upload-test

once the package looks good, run make upload.