Audit log¶
Wagtail provides a mechanism to log actions performed on its objects. Common activities such as page creation, update, deletion, locking and unlocking, revision scheduling, and privacy changes are automatically logged at the model level.
The Wagtail admin uses the action log entries to provide a site-wide and page-specific history of changes. It uses a registry of ‘actions’ that provide additional context for the logged action.
The audit log-driven Page history replaces the revisions list page but provides a filter for revision-specific entries.
Note
The audit log does not replace revisions.
The wagtail.log_actions.log
function can be used to add logging to your own code.
- log(instance, action, user=None, uuid=None, title=None, data=None)¶
Adds an entry to the audit log.
- Parameters:
instance – The model instance that the action is performed on
action – The code name for the action being performed. This can be one of the names listed below or a custom action defined through the register_log_actions hook.
user – Optional - the user initiating the action. For actions logged within an admin view, this defaults to the logged-in user.
uuid – Optional - log entries given the same UUID indicates that they occurred as part of the same user action (for example a page being immediately published on creation).
title – The string representation, of the instance being logged. By default, Wagtail will attempt to use the instance’s
str
representation orget_admin_display_title
for page objects.data – Optional - a dictionary of additional JSON-serialisable data to store against the log entry
Note
When adding logging, you need to log the action or actions that happen to the object. For example, if the user creates and publishes a page, there should be a “create” entry and a “publish” entry. Or, if the user copies a published page and chooses to keep it published, there should be a “copy” and a “publish” entry for the new page.
# mypackage/views.py
from wagtail.log_actions import log
def copy_for_translation(page):
# ...
page.copy(log_action='mypackage.copy_for_translation')
def my_method(request, page):
# ..
# Manually log an action
data = {
'make': {'it': 'so'}
}
log(
instance=page, action='mypackage.custom_action', data=data
)
Log actions provided by Wagtail¶
Action |
Notes |
---|---|
|
The object was created |
|
The object was edited (for pages, saved as a draft) |
|
The object was deleted. Will only surface in the Site History for administrators |
|
The page was published |
|
The draft is scheduled for publishing |
|
Draft published via |
|
Draft scheduled for publishing canceled via “Cancel scheduled publish” |
|
The page was unpublished |
|
Page unpublished via |
|
Page was locked |
|
Page was unlocked |
|
A page was renamed |
|
The page was reverted to a previous draft |
|
The page was copied to a new location |
|
The page was copied into a new locale for translation |
|
The page was moved to a new location |
|
The order of the page under its parent was changed |
|
The page was restricted |
|
The page restrictions were updated |
|
The page restrictions were removed |
|
The page was submitted for moderation in a Workflow |
|
The draft was approved at a Workflow Task |
|
The draft was rejected, and changes were requested at a Workflow Task |
|
The draft was resubmitted to the workflow |
|
The workflow was canceled |
Log context¶
The wagtail.log_actions
module provides a context manager to simplify code that logs a large number of actions,
such as import scripts:
from wagtail.log_actions import LogContext
with LogContext(user=User.objects.get(username='admin')):
# ...
log(page, 'wagtail.edit')
# ...
log(page, 'wagtail.publish')
All log
calls within the block will then be attributed to the specified user, and assigned a common UUID. A log context is created automatically for views within the Wagtail admin.
Log models¶
Logs are stored in the database via the models wagtail.models.PageLogEntry
(for actions on Page instances) and
wagtail.models.ModelLogEntry
(for actions on all other models). Page logs are stored in their own model to
ensure that reports can be filtered according to the current user’s permissions, which could not be done efficiently
with a generic foreign key.
If your own models have complex reporting requirements that would make ModelLogEntry
unsuitable, you can configure
them to be logged to their own log model; this is done by subclassing the abstract wagtail.models.BaseLogEntry
model, and registering that model with the log registry’s register_model
method:
from myapp.models import Sprocket, SprocketLogEntry
# here SprocketLogEntry is a subclass of BaseLogEntry
@hooks.register('register_log_actions')
def sprocket_log_model(actions):
actions.register_model(Sprocket, SprocketLogEntry)