django-auditlog documentation

django-auditlog (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries to use as much as Python and Django’s built in functionality to keep the list of dependencies as short as possible. Also, Auditlog aims to be fast and simple to use.

Auditlog is created out of the need for a simple Django app that logs changes to models along with the user who made the changes (later referred to as actor). Existing solutions seemed to offer a type of version control, which was found excessive and expensive in terms of database storage and performance.

The core idea of Auditlog is similar to the log from Django’s admin. However, Auditlog is much more flexible than the log from Django’s admin app (django.contrib.admin). Also, Auditlog saves a summary of the changes in JSON format, so changes can be tracked easily.

Contents

• Installation
  • Adding Auditlog to your Django application
• Usage
  • Manually logging changes
  • Automatically logging changes
  • Correlation ID
  • Settings
  • Actors
  • Context managers
  • Object history
  • Many-to-many relationships
  • Management commands
  • Django Admin integration
• Upgrading to version 3
• Internals
  • Models and fields
  • Middleware
  • Correlation ID
  • Signal receivers
  • Custom Signals
  • Calculating changes
  • Registry

Contribute to Auditlog

If you discovered a bug or want to improve the code, please submit an issue and/or pull request via GitHub. Before submitting a new issue, please make sure there is no issue submitted that involves the same problem.

GitHub repository: https://github.com/jazzband/django-auditlog

Issues: https://github.com/jazzband/django-auditlog/issues