django-uxlite 0.2.1

Reusable Django app for API request/event analytics, crash logging, and PII-safe masking, viewable in Django admin.

django-uxlite

Reusable Django app that adds UXCam-style request/event analytics, crash logging, and PII masking to API services (Django REST Framework friendly), all viewable in Django admin. No client-side JS or session replay — built for API-only backends.

Install

pip install -e /path/to/django-uxlite

Setup

1. Add to INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    "uxlite",
]

2. Add the middleware (near the top, after auth middleware so request.user is set):

MIDDLEWARE = [
    ...,
    "uxlite.middleware.UXLiteTrackingMiddleware",
]

3. Migrate:

python manage.py migrate uxlite

4. Optional settings (all have defaults, see uxlite/settings_defaults.py):

UXLITE_SENSITIVE_FIELDS = ["password", "token", "email", "card_number", "ssn"]
UXLITE_RETENTION_DAYS = 90
UXLITE_MASK_VALUE = "***"
UXLITE_TRACK_PATHS_EXCLUDE = ["/admin/", "/static/", "/media/", "/health/"]

Usage

Custom events

from uxlite.tracking import track_event

def checkout_view(request):
    ...
    track_event("checkout_completed", request=request, meta={"order_id": order.id, "email": user.email})

Sensitive keys in meta are masked automatically before being stored, based on UXLITE_SENSITIVE_FIELDS.

Crash logging

Wired up automatically via the got_request_exception signal — no extra code needed for exceptions that reach Django as unhandled (including plain Django views and any exception type DRF doesn't recognize).

If you're using Django REST Framework, DRF's own exception handler catches APIException/Http404/PermissionDenied before they become unhandled, which would otherwise hide 5xx-worthy failures from CrashLog. Opt in with:

REST_FRAMEWORK = {
    "EXCEPTION_HANDLER": "uxlite.exceptions.drf_exception_handler",
}

This still returns DRF's normal error response — it only additionally logs a CrashLog row when the resolved response status is 5xx.

Purge old data

python manage.py uxlite_purge

Deletes RequestLog, Event, and CrashLog rows older than UXLITE_RETENTION_DAYS. Session rows with no remaining RequestLog/Event rows are cleaned up too.

Admin

Everything (RequestLog, Session, Event, CrashLog) is registered in Django admin with search/filter support — no extra dashboard UI needed.

Out of scope (v1)

• Pixel-accurate session replay (DOM/gesture recording)
• AI-analyst / auto-insight generation
• Client-side JS heatmaps