Skip to content

Doc 12634 76 #3960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: release/7.6
Choose a base branch
from
Open

Doc 12634 76 #3960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0ef2fd
DOC-12634-76-pruneageetc
TimLFletcher Nov 5, 2025
b0ec4fd
updated manage page
TimLFletcher Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/manage/pages/manage-security/manage-auditing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,6 @@ Likewise, a list of `disabledUsers` is specified.
See xref:manage:manage-security/manage-auditing.adoc#ignoring-events-by-user[Ignoring Filterable Events By User], above, for information.
Note, however, that when specified using the REST API, local and internal usernames take the `/local`, rather than the `/couchbase` suffix.
The `rotateSize` is specified in bytes, and the `rotateInterval` in seconds.
The `pruneAge` parameter tells Couchbase Server to automatically delete rotated audit logs after 10800 minutes (1 week).
The `pruneAge` parameter tells Couchbase Server to automatically delete rotated audit logs after 10800 seconds (3 hours).

See xref:rest-api:rest-auditing.adoc[Configure Auditing], for more detailed information; including use of the `GET /settings/audit` method and URI to retrieve the current audit configuration.
13 changes: 7 additions & 6 deletions modules/rest-api/pages/rest-auditing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down