django-audit
Django Audit is a simple Django app that tracks and logs requests to your application.
Quick Start
- Install django-audit
pip install dj-audit
- Add
dj_audit
to your INSTALLED_APPS:
INSTALLED_APPS = [
...,
"dj_audit"
]
- Add
dj_audit
middleware:
MIDDLEWARE = [
...
"dj_audit.middleware.AuditMiddleware"
]
if you want access to the dj-audit dashboard, then add the following to your urls.py
urlpatterns = [
path("admin/", admin.site.urls),
path("dj-audit/", include('dj_audit.urls'))
]
- Run migrate
python manage.py migrate
Management commands
flush_auditlog
- Cleans up dj-audit AuditLog table
python manage.py flush_auditlog
Customizing dj-audit
You have a couple options available to you to customize dj-audit
a bit. These should be defined in your settings.py
file.
DISABLE_AUDIT_LOG
: bool: Disable or Enable dj_auditAUDIT_LOG_TEMPLATE
: str: If set, the template here will be render when the user visits the audit log page (i.e /dj-audit/audit-logs/)REQUEST_STATUS_TEMPLATE
: str: If set, the template here will be render when the user visits the request status page (i.e /dj-audit/request-status/)API_BASE_URL
: str: Base url for API requests if any
Test
make test
or with coverage
make coverage_test