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

audit.ini [AuditBufferSettings]

The settings of [AuditBufferSettings] in audit.ini: Buffering, ImmediateEvents, MaxEvents, MaxBytes, FlushInterval

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/audit/AuditBufferSettings.md

On this page

audit.ini [AuditBufferSettings]

The block [AuditBufferSettings] of settings/audit.ini, with 5 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).

Buffering

F3: events are collected and written in one append per channel at the end of the
request (also on a fatal error, through the shutdown handler). enabled | disabled
(disabled writes every event at once: for debugging only).

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditBufferSettings]
Buffering=enabled
*/ ?>

ImmediateEvents

Events written at once, not buffered (F3: security events): patterns.

Default: a list of 3: access.*, system.audit.*, system.setting.write.

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

MaxEvents

Flush early when the buffer holds this many events or this many bytes (long requests,
commands). K, M suffixes.

Default: 500.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditBufferSettings]
MaxEvents=500
*/ ?>

MaxBytes

Default: 1M.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditBufferSettings]
MaxBytes=1M
*/ ?>

FlushInterval

Commands, cronjob parts and content job workers also flush every this many seconds.

Default: 5.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditBufferSettings]
FlushInterval=5
*/ ?>

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