Skip to main content

A Django app for advanced logging capabilities

Project description

Django Tracker

Django Tracker is a middleware for Django that automatically audits and logs all model changes made through user requests. It records the user responsible, the fields changed, and other useful information for tracking data changes.

Installation

pip install django-tracker-unergy

Setup

  1. Add 'django_tracker' to INSTALLED_APPS in your settings.py:
INSTALLED_APPS = [
    # ...
    'django_tracker',
]

and add the middleware

MIDDLEWARE = [
    # ...
    'django_tracker.middleware.CurrentUserMiddleware'
]
  1. Run migrations:
python manage.py makemigrations
python manage.py migrate django_tracker

Usage

Auditable Decorator

from django_tracker.decorators import auditable

@auditable(
    tracked_fields=['field1', 'field2'],
    exclude_fiels=["created_at", "updated_at"]
    audit_creates=True,
    audit_updates=True,
    audit_deletes=True,
    level=AuditLevel.MEDIUM
)
class MyModel(models.Model):
    field1 = models.CharField(max_length=100)
    field2 = models.IntegerField()
    # And the control attrb

Querying Audit Logs

You can view audit logs in the Django admin or directly from the model:

from django_tracker.models import AuditLog

# Get changes for a specific object
logs = AuditLog.objects.filter(
    content_type__model='mymodel',
    object_id=obj_id
)

# Get changes by user
logs = AuditLog.objects.filter(username='username')

License

MIT License. See LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_tracker_unergy-1.0.4.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_tracker_unergy-1.0.4-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file django_tracker_unergy-1.0.4.tar.gz.

File metadata

  • Download URL: django_tracker_unergy-1.0.4.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.13

File hashes

Hashes for django_tracker_unergy-1.0.4.tar.gz
Algorithm Hash digest
SHA256 f05894968a56d2f2af75a0966279816f31faf2c99d6d8795c8e15ce470042a2a
MD5 57688e24e3560b6fd6b4727c49e9b07a
BLAKE2b-256 79fd9d74a27d8ea8768ec235cc562235b8b1e64924cb0b9fe2287348833cca2a

See more details on using hashes here.

File details

Details for the file django_tracker_unergy-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for django_tracker_unergy-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b5ecc3151320e97c09347b0cc2811cd6a45088849b8efe84468bd5f2e8299d5b
MD5 ede7257dfdb2e7c13101f8a83ac3e69d
BLAKE2b-256 754c788aa3041c287afeeb7d97a8f91404573be02677587c0a84044b7936381b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page