From bb4c4bd3c00bc98344eca1ec0ac7df849ed4e993 Mon Sep 17 00:00:00 2001 From: TimLFletcher Date: Wed, 5 Nov 2025 18:02:25 +0000 Subject: [PATCH] DOC-12634-72-pruneageetc --- modules/rest-api/pages/rest-auditing.adoc | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/modules/rest-api/pages/rest-auditing.adoc b/modules/rest-api/pages/rest-auditing.adoc index 455c142a83..697d00d9a7 100644 --- a/modules/rest-api/pages/rest-auditing.adoc +++ b/modules/rest-api/pages/rest-auditing.adoc @@ -58,16 +58,17 @@ When auditing is enabled, all _non-filterable_ events are audited; and none can * The `logPath` parameter specifies the pathname of the directory to which the `audit.log` file is written. [#pruneAge] -* The `pruneAge` parameter sets the number of minutes Couchbase Server keeps rotated audit logs. +* The `pruneAge` parameter sets the number of seconds Couchbase Server keeps rotated audit logs. When set to the minimum value 0 (the default), Couchbase Server does not prune rotated audit logs. -If set to a value greater than 0, Couchbase Server deletes rotated audit logs that are older than this value in minutes. -The maximum value for this setting is 35791394 (4085 years). +If set to a value greater than 0, Couchbase Server deletes rotated audit logs that are older than this value in seconds. +The maximum value for this setting is 35791394 (1 year, 45 days, 15 hours, 29 minutes, and 54 seconds). * The `rotateInterval` parameter specifies the maximum time-period that is to elapse between log-rotations. -Its value must be a number of seconds, in the range of 900 (15 minutes) to 604800 (7 days), inclusive. +Its value must be a number of seconds and must be a multiple of 60. The value must also be in the range of 900 (15 minutes) to 604800 (7 days), inclusive. * The `rotateSize` parameter specifes the maximum size to which the `audit.log` file is permitted to grow, before being rotated. -Its value must be a number of bytes, in the range of 0 to 524288000 (500 MB), inclusive. +Its value must be a number of bytes, in the range of 11048576 to 524288000 (1 MiB to 500 MiB), inclusive. +The default is 20971520 (20 MiB). * The `disabled` parameter indicates which individual _filterable_ events are disabled. Its value must be one or more filterable-event ids, specified as a comma-separated list, without spaces. @@ -124,7 +125,7 @@ Each member is an object of two elements, which are the _name_ of the disabled u * _logPath_: The current value of the pathname to which the `audit.log` file is being written. -* _pruneAge_: The number of minutes Couchbase Server keeps rotated audit logs. The value `0` means Couchbase Server does not automatically prune these logs. +* _pruneAge_: The number of seconds Couchbase Server keeps rotated audit logs. The value `0` means Couchbase Server does not automatically prune these logs. * _rotateInterval_: An integer that is the number of seconds in the maximum time-period on whose elapse the log file is rotated.