summaryrefslogtreecommitdiff
path: root/auditlog/readme/USAGE.rst
diff options
context:
space:
mode:
Diffstat (limited to 'auditlog/readme/USAGE.rst')
-rw-r--r--auditlog/readme/USAGE.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/auditlog/readme/USAGE.rst b/auditlog/readme/USAGE.rst
new file mode 100644
index 0000000..b09f7d9
--- /dev/null
+++ b/auditlog/readme/USAGE.rst
@@ -0,0 +1,25 @@
+Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines
+which operations to log for a given data model.
+
+.. image:: ../static/description/rule.png
+
+Then, check logs in the `Settings / Technical / Audit / Logs` menu. You can
+group them by user sessions, date, data model or HTTP requests:
+
+.. image:: ../static/description/logs.png
+
+Get the details:
+
+.. image:: ../static/description/log.png
+
+A scheduled action exists to delete logs older than 6 months (180 days)
+automatically but is not enabled by default.
+To activate it and/or change the delay, go to the
+`Configuration / Technical / Automation / Scheduled Actions` menu and edit the
+`Auto-vacuum audit logs` entry:
+
+.. image:: ../static/description/autovacuum.png
+
+In case you're having trouble with the amount of records to delete per run,
+you can pass the amount of records to delete for one model per run as the second
+parameter, the default is to delete all records in one go.