From c3b1f48b710a20d5a03092af2eabb8d3f140ca67 Mon Sep 17 00:00:00 2001 From: TimLFletcher Date: Wed, 5 Nov 2025 17:39:53 +0000 Subject: [PATCH 1/3] DOC-12634 Fixed prunage units from minutes to seconds --- modules/rest-api/pages/rest-auditing.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/rest-api/pages/rest-auditing.adoc b/modules/rest-api/pages/rest-auditing.adoc index cec2cd9bdf..9d84a42cdf 100644 --- a/modules/rest-api/pages/rest-auditing.adoc +++ b/modules/rest-api/pages/rest-auditing.adoc @@ -72,10 +72,10 @@ 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. @@ -138,7 +138,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. From fe17d316cc265be84b5fdca118d89ab7b1f4e110 Mon Sep 17 00:00:00 2001 From: TimLFletcher Date: Wed, 5 Nov 2025 17:58:08 +0000 Subject: [PATCH 2/3] further updates on units and min/max/defaults --- modules/rest-api/pages/rest-auditing.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/rest-api/pages/rest-auditing.adoc b/modules/rest-api/pages/rest-auditing.adoc index 9d84a42cdf..c7c4589cac 100644 --- a/modules/rest-api/pages/rest-auditing.adoc +++ b/modules/rest-api/pages/rest-auditing.adoc @@ -78,10 +78,11 @@ If set to a value greater than 0, Couchbase Server deletes rotated audit logs th 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. From 2de4d7d5adcc5f5db7eaeec06cf281db2f8e56f8 Mon Sep 17 00:00:00 2001 From: TimLFletcher Date: Wed, 5 Nov 2025 18:18:58 +0000 Subject: [PATCH 3/3] updated manage page --- modules/manage/pages/manage-security/manage-auditing.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/manage/pages/manage-security/manage-auditing.adoc b/modules/manage/pages/manage-security/manage-auditing.adoc index 6410819ea0..bcfaa5f26b 100644 --- a/modules/manage/pages/manage-security/manage-auditing.adoc +++ b/modules/manage/pages/manage-security/manage-auditing.adoc @@ -265,7 +265,7 @@ NOTE: When you list the users using the REST API, the local and internal usernam * Specify `rotateSize` in bytes and `rotateInterval` in seconds. -* Use the `pruneAge` parameter to instruct Couchbase Server to automatically delete rotated audit logs after 10800 minutes or a week. +* Use the `pruneAge` parameter to instruct Couchbase Server to automatically delete rotated audit logs after 10800 seconds (3 hours). [#auditing-user-activity] == Auditing User Activity