drf-audit-trail 0.3.1

A reusable django [DRF] application that handles auditing of requests and logins

DRF Audit Trail

A reusable Django [DRF] application that handles auditing of requests and logins.

Features

• Request audit trail
• Logins audit trail
• Integration with simplejwt
• Support for Django Async
• Thread Safe
• Error tracking

Usage

To use this app, you need to install it, add it to the Django INSTALLED_APPS, and configure the middleware in your Django settings.

Installation

pip install drf-audit-trail

Configuration

Add to Django INSTALLED_APPS

# settings.py

INSTALLED_APPS = [
    ...
    "drf_audit_trail",
]

Configure the middleware

Add to Django MIDDLEWARE configuration

# settings.py

MIDDLEWARE = [
    ...
    "drf_audit_trail.middleware.RequestLoginAuditEventMiddleware",
]

Settings

In your settings.py, configure

DRF_AUDIT_TRAIL_REQUEST_AUDIT_URLS: A list that accepts regex patterns indicating which URLs should be tracked.

Example:

Default: [r"^/api/.*?/"]

DRF_AUDIT_TRAIL_REQUEST_AUDIT_URLS = [r"^/api/.*?/"]

This means that all requests starting with /api/ will be tracked.

---

DRF_AUDIT_TRAIL_AUTH_URL: The endpoint used to authenticate users.

Default: /api/token/

DRF_AUDIT_TRAIL_AUTH_URL = "/api/token/"

---

DRF_AUDIT_TRAIL_AUTH_STATUS_CODE_FAILED: The status code returned when the auth request failed

Default: 401

DRF_AUDIT_TRAIL_AUTH_STATUS_CODE_FAILED = 401

Flow

DER

RequestLoginAuditEventMiddleware class diagram