Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

Extension points in audit.ini

Settings of audit.ini that list handlers, classes or directories an extension can add to (25, found by name).

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/extension-points/audit.md

On this page

Extension points in audit.ini

Settings of settings/audit.ini whose name says they hold handlers, classes, filters, providers or directories that an extension can add to or replace. Found by the setting's name: a heuristic. Read the setting's comment (linked) before relying on it.

An extension adds to a list in its own settings/audit.ini.append.php (active extensions' settings are read after the kernel's and before settings/override):

AuditChannel_content Sinks

Shipped: an empty list. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditChannel_content]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditChannel_access Sinks

Shipped: a list of 2: syslog, useraudit. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditChannel_access]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditChannel_system Sinks

Shipped: a list of 1: syslog. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditChannel_system]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditChannel_commerce Sinks

Shipped: an empty list. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditChannel_commerce]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditChannel_read Sinks

Shipped: an empty list. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditChannel_read]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditReadSettings Classes

Shipped: an empty list. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditReadSettings]
Classes[]=expExampleClasse    # your class or value, added to the list
*/ ?>

AuditSinkSettings SinkClasses

Shipped: a hash of 4: syslog=expAuditSyslogSink, webhook=expAuditWebhookSink, mail=expAuditMailSink, useraudit=expAuditUserAuditSink. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditSinkSettings]
SinkClasses[expexample]=expExampleSinkClasse    # key and value are yours
*/ ?>

AuditSink_syslog Transport

Shipped: local. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditSink_syslog]
Transport=local    # replace with your class or value
*/ ?>

AuditSink_mail Transport

Shipped: empty. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditSink_mail]
Transport=    # replace with your class or value
*/ ?>

AuditAlertSettings RuleClasses

Shipped: a hash of 3: threshold=expAuditThresholdRule, match=expAuditMatchRule, schedule=expAuditScheduleRule. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditAlertSettings]
RuleClasses[expexample]=expExampleRuleClasse    # key and value are yours
*/ ?>

AlertRule_brute_force Class

Shipped: threshold. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_brute_force]
Class=threshold    # replace with your class or value
*/ ?>

AlertRule_brute_force Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_brute_force]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_brute_force_user Class

Shipped: threshold. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_brute_force_user]
Class=threshold    # replace with your class or value
*/ ?>

AlertRule_brute_force_user Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_brute_force_user]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_admin_role_granted Class

Shipped: match. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_admin_role_granted]
Class=match    # replace with your class or value
*/ ?>

AlertRule_admin_role_granted Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_admin_role_granted]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_settings_out_of_hours Class

Shipped: schedule. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_settings_out_of_hours]
Class=schedule    # replace with your class or value
*/ ?>

AlertRule_settings_out_of_hours Sinks

Shipped: a list of 1: syslog. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_settings_out_of_hours]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_mass_delete Class

Shipped: threshold. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_mass_delete]
Class=threshold    # replace with your class or value
*/ ?>

AlertRule_mass_delete Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_mass_delete]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_audit_disabled Class

Shipped: match. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_audit_disabled]
Class=match    # replace with your class or value
*/ ?>

AlertRule_audit_disabled Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_audit_disabled]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AlertRule_chain_broken Class

Shipped: match. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_chain_broken]
Class=match    # replace with your class or value
*/ ?>

AlertRule_chain_broken Sinks

Shipped: a list of 2: syslog, mail. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AlertRule_chain_broken]
Sinks[]=expExampleSink    # your class or value, added to the list
*/ ?>

AuditArchiveSettings FormatHandlers

Shipped: a hash of 5: gzip=expAuditGzipFormat, bzip2=expAuditBzip2Format, xz=expAuditXzFormat, zstd=expAuditZstdFormat, zip=expAuditZipFormat. The setting.

<?php /* #?ini charset="utf-8"?
# extension/expexample/settings/audit.ini.append.php
[AuditArchiveSettings]
FormatHandlers[expexample]=expExampleFormatHandler    # key and value are yours
*/ ?>

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x