audit.ini [AuditRecordSettings] #

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

BeforeAfter #

Record before/after values (Q2). enabled | keys (keys kept, values replaced by their
sha256) | disabled. Secrets are never recorded either way.

Default: enabled.

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

MaxValueLength #

Longest value kept in before/after/object fields, in characters; longer ones are cut
and end in "…".

Default: 512.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditRecordSettings]
MaxValueLength=512
*/ ?>

ChildDepth #

Child events (F2): how many levels below a parent are written one by one, and how many
children per parent at most. Past either limit the parent counts the rest in
after.children_omitted. 0 = no children at all.

Default: 3.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditRecordSettings]
ChildDepth=3
*/ ?>

MaxChildren #

Default: 10000.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditRecordSettings]
MaxChildren=10000
*/ ?>

RequestContext #

Extra request fields. enabled | disabled

Default: enabled.

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

RequestIdHeader #

Send the request id as a response header (F2); an empty value sends none. Named like
the other X-Exp-* headers of Exponential (X-Exp-Cache).

Default: X-Exp-Request-Id.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditRecordSettings]
RequestIdHeader=X-Exp-Request-Id
*/ ?>

TrustedRequestIdHeader #

Accept the request id from a trusted front proxy instead of making one; empty = never.
The header is only trusted from the addresses in TrustedProxies[] (site.ini's list
when empty).

Default: empty.

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

MaxLineBytes #

Longest line the writer reads back to find the chain's head, in bytes.

Default: 262144.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditRecordSettings]
MaxLineBytes=262144
*/ ?>

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.