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 [AuditReadSettings]

The settings of [AuditReadSettings] in audit.ini: Reads, SampleRate, Sections, Classes, AlwaysModules

Download as PDF

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

On this page

audit.ini [AuditReadSettings]

The block [AuditReadSettings] 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).

Reads

Z6: reads are optional and sampled. enabled | disabled

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditReadSettings]
Reads=disabled
*/ ?>

SampleRate

Share of reads recorded, 0.0 to 1.0 (0.01 = one in a hundred).

Default: 0.01.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditReadSettings]
SampleRate=0.01
*/ ?>

Sections

Only reads in these sections or of these classes (identifiers); empty = all.

Default: an empty list.

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

Classes

Default: an empty list.

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

AlwaysModules

Views of these modules are always recorded, sampled or not, Reads on or off
(access.view.sensitive).
Proposed: settings writes go through setup and settings; the settings module's views
are sensitive too.

Default: a list of 5: setup, role, user, audit, settings.

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

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