audit.ini [AuditEventSettings] #

The block [AuditEventSettings] of settings/audit.ini, with 4 setting(s).

Never edit settings/audit.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/audit.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/audit.ini.append.php for one siteaccess,
• extension/<extension>/settings/audit.ini.append.php in an extension (read when the extension is active).

Enabled #

Which events are recorded, by taxonomy pattern: a whole domain (content.*), a subject
(content.node.*), an action with its details (content.node.remove.*) or one name.
The most specific pattern wins; on a tie the later line wins. Events marked "always"
in the catalogue (system.audit.*, access.view.sensitive) ignore Disabled[].
Migrations (migration.ini): a run, a migration applied (also a changed file accepted with
--force --reason), failed or rolled back, a caption taken, the migrations repository pushed,
and the requests, mails and console commands of their http, mail and command steps.
A site that switches system.* off keeps them with these lines.
Static publishing: a publish (also a push tried again), a rollback, a deploy key made, a target saved, a build,
a post to the form endpoint.

Default: a list of 52: access.*, system.*, system.migration.run, system.migration.apply, system.migration.fail, system.migration.rollback, system.migration.caption, system.migration.push, system.migration.http, system.migration.mail, system.migration.command, system.migration.record ....

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditEventSettings]
# an empty "Enabled[]" first replaces the shipped list; without it the items are added
Enabled[]
Enabled[]=access.*
Enabled[]=system.*
Enabled[]=system.migration.run
Enabled[]=system.migration.apply
Enabled[]=system.migration.fail
Enabled[]=system.migration.rollback
Enabled[]=system.migration.caption
Enabled[]=system.migration.push
Enabled[]=system.migration.http
Enabled[]=system.migration.mail
Enabled[]=system.migration.command
Enabled[]=system.migration.record
Enabled[]=system.migration.deploy
Enabled[]=system.migration.deploy.rollback
Enabled[]=system.migration.remote
Enabled[]=system.staticpublish.publish
Enabled[]=system.staticpublish.rollback
Enabled[]=system.staticpublish.credential
Enabled[]=system.staticpublish.target
Enabled[]=system.staticpublish.build
# ... 32 more in the shipped file
*/ ?>

Disabled #

Default: a list of 2: access.session.regenerate, access.session.expire.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditEventSettings]
# an empty "Disabled[]" first replaces the shipped list; without it the items are added
Disabled[]
Disabled[]=access.session.regenerate
Disabled[]=access.session.expire
*/ ?>

Branches #

Reads are switched on in [AuditReadSettings], not here.

Extensions register their taxonomy branches: name => the branch class (implements
expAuditTaxonomyBranch), which lists the names, their severity, channel and the
privacy of its own fields. Counted by the RAD survey (registry "auditbranches").
Branches[myext]=myExtAuditBranch

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditEventSettings]
# an empty "Branches[]" first replaces the shipped list; without it the items are added
Branches[]
*/ ?>

MinSeverity #

The severity (RFC 5424 name) below which an event is not recorded at all.
debug | info | notice | warning | error | critical | alert | emergency

Default: info.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditEventSettings]
MinSeverity=info
*/ ?>

Related #

• All blocks of audit.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/audit.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.