Skip to the content
Documentation

[AuditAlertSettings]

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The group [AuditAlertSettings] of settings/audit.ini.

File

settings/audit.ini; override it in settings/override/audit.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
Alerts enabled F5: built-in rules, INI rules ([AlertRule_*]) and rule classes. enabled | disabled
EvaluateIn[] flush; cronjob Where rules are evaluated: flush (at the end of the request that wrote the event) and cronjob (the audit cronjob part, for windows and rules over many requests).
Rules[] brute_force; brute_force_user; admin_role_granted; settings_out_of_hours; mass_delete; audit_disabled; chain_broken The rules in use: [AlertRule_<name>] blocks.
RuleClasses[<key>] threshold=expAuditThresholdRule; match=expAuditMatchRule; schedule=expAuditScheduleRule Rule classes: name => class implementing expAuditAlertRule (RAD survey registry "auditalertrules").
BusinessDays 1-5 Business hours for rules with OutOfHours=enabled: days 1 (Mon) … 7 (Sun), hours 0-24, in the site's time zone.
BusinessHours 7-19  
Recipients[] (empty array) Who gets alert mail (rules with Sinks[]=mail, and any other record mailed): the default list. A rule's own [AlertRule_<rule>] Recipients[] replaces it for that rule. Empty (and [AuditSink_mail] Receivers[] empty too) = the site's AdminEmail. One recipient per line, combinable; addresses are deduplicated (case-insensitive), users are resolved when the mail is sent with their current e-mail address, disabled users are left out, and nothing in the event itself ever becomes a recipient: admin site.ini [MailSettings] AdminEmail address:[email protected] an e-mail address (a bare address with @ works too) group:security the named list [AlertRecipients_security] below user:14 the user with content object id 14 login:editor1 the user with that login usergroup:12 every user below the user group with node id 12, sub-groups included (usergroup:<remote id> works too, the node's or the object's remote id) role:Administrator every user the role is assigned to, directly or through a user group (role:<role id> works too) Mail is throttled per rule (or event name) and recipient ([AuditSink_mail] Throttle). Show who would get what: ./console exp:audit alerts recipients [--rule=<rule>]

See also

Generated example: audit.ini [AuditAlertSettings]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/audit.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.