Manually logging changes¶
Auditlog log entries are simple
LogEntry model instances. This makes creating a new log entry very easy. For
even more convenience,
LogEntryManager provides a number of methods which take some work out of your hands.
See Internals for all details.
Automatically logging changes¶
Auditlog can automatically log changes to objects for you. This functionality is based on Django’s signals, but linking your models to Auditlog is even easier than using signals.
Registering your model for logging can be done with a single line of code, as the following example illustrates:
from auditlog.registry import auditlog from django.db import models class MyModel(models.Model): pass # Model definition goes here auditlog.register(MyModel)
It is recommended to place the register code (
auditlog.register(MyModel)) at the bottom of your
This ensures that every time your model is imported it will also be registered to log changes. Auditlog makes sure that
each model is only registered once, otherwise duplicate log entries would occur.
Fields that are excluded will not trigger saving a new log entry and will not show up in the recorded changes.
To exclude specific fields from the log you can pass
exclude_fields to the
exclude_fields is specified the fields with the given names will not be included in the generated log
include_fields is specified only the fields with the given names will be included in the generated log
entries. Explicitly excluding fields through
exclude_fields takes precedence over specifying which fields to
For example, to exclude the field
New in version 0.3.0: Excluding fields
When using automatic logging, the actor is empty by default. However, auditlog can set the actor from the current request automatically. This does not need any custom code, adding a middleware class is enough. When an actor is logged the remote address of that actor will be logged as well.
To enable the automatic logging of the actors, simply add the following to your
MIDDLEWARE_CLASSES setting in your
project’s configuration file:
MIDDLEWARE_CLASSES = ( # Request altering middleware, e.g., Django's default middleware classes 'auditlog.middleware.AuditlogMiddleware', # Other middleware )
It is recommended to keep all middleware that alters the request loaded before Auditlog’s middleware.
Please keep in mind that every object change in a request that gets logged automatically will have the current request’s user as actor. To only have some object changes to be logged with the current request’s user as actor manual logging is required.
Auditlog ships with a custom field that enables you to easily get the log entries that are relevant to your object. This
functionality is built on Django’s content types framework (
django.contrib.contenttypes). Using this field in
your models is equally easy as any other field:
from auditlog.models import AuditlogHistoryField from auditlog.registry import auditlog from django.db import models class MyModel(models.Model): history = AuditlogHistoryField() # Model definition goes here auditlog.register(MyModel)
AuditlogHistoryField accepts an optional
pk_indexable parameter, which is either
False, this defaults to
True. If your model has a custom primary key that is not an integer value,
pk_indexable needs to be set to
False. Keep in mind that this might slow down queries.
New in version 0.3.0.
To-many relations are not officially supported. However, this section shows a workaround which can be used for now. In the future, this workaround may be used in an official API or a completly different strategy might be chosen. Do not rely on the workaround here to be stable across releases.
By default, many-to-many relationships are not tracked by Auditlog.
The history for a many-to-many relationship without an explicit ‘through’ model can be recorded by registering this model as follows:
The log entries for all instances of the ‘through’ model that are related to a
MyModel instance can be retrieved
LogEntryManager.get_for_objects() method. The resulting QuerySet can be combined with any other
LogEntry instances. This way it is possible to get a list of all changes on an object and its
obj = MyModel.objects.first() rel_history = LogEntry.objects.get_for_objects(obj.related.all()) full_history = (obj.history.all() | rel_history.all()).order_by('-timestamp')
New in version 0.4.0.
Auditlog provides the
auditlogflush management command to clear all log entries from the database.
The command asks for confirmation, it is not possible to execute the command without giving any form of (simulated) user input.
auditlogflush command deletes all log entries permanently and irreversibly from the database.
Django Admin integration¶
New in version 0.4.1.
auditlog is added to your
INSTALLED_APPS setting a customized admin class is active providing an enhanced
Django Admin interface for log entries.