salopulse-django 1.0.0

SaloPulse SDK for Django — error, performance and SQL monitoring.

SaloPulse Django SDK

Error, performance and SQL monitoring for Django apps. Byte-compatible wire protocol with the SaloPulse Ruby SDK.

Install

pip install salopulse-django

Quickstart

Add the middleware to settings.py (as early as possible, ideally first):

MIDDLEWARE = [
    "salopulse_django.middleware.SalopulseMiddleware",
    # ... your other middleware ...
]

Initialize the SDK at startup (e.g. in settings.py, wsgi.py or your app's AppConfig.ready):

import os
import salopulse_django

salopulse_django.init(dsn=os.environ["SALOPULSE_DSN"])

That's it. Requests now emit a performance event (with span_count), captured SQL queries (with N+1 detection), and unhandled exceptions automatically.

Optional: auto-init via INSTALLED_APPS

Instead of calling init yourself, add the app and set SALOPULSE_DSN in the environment or settings:

INSTALLED_APPS = [
    # ...
    "salopulse_django",
]

Configuration

salopulse_django.init(
    dsn=os.environ["SALOPULSE_DSN"],
    release="v1.2.3",
    environment="production",
    service="checkout-api",
    sample_rate=1.0,
)

When dsn is omitted, the SDK reads SALOPULSE_DSN from the environment or Django settings. The DSN format is https://<api_key>@host[:port].

API

import salopulse_django

salopulse_django.capture_exception(err)
salopulse_django.capture_message("something happened", level="warning")
salopulse_django.set_user(id=123, email="[e-mail]")
salopulse_django.flush()   # flush buffered events now
salopulse_django.close()   # stop the background flusher (called on exit)

The SDK never raises into your app: a missing or invalid DSN makes every call a safe no-op.

License

MIT — see LICENSE.