Skip to content

Add docs for CLUSTER_SETTINGS_CHANGED and INDEX_SETTINGS_CHANGED audit categories#12526

Open
cwperks wants to merge 1 commit into
opensearch-project:mainfrom
cwperks:audit-log-settings
Open

Add docs for CLUSTER_SETTINGS_CHANGED and INDEX_SETTINGS_CHANGED audit categories#12526
cwperks wants to merge 1 commit into
opensearch-project:mainfrom
cwperks:audit-log-settings

Conversation

@cwperks

@cwperks cwperks commented Jun 17, 2026

Copy link
Copy Markdown
Member

Description

Adds public documentation for the new CLUSTER_SETTINGS_CHANGED and INDEX_SETTINGS_CHANGED audit log categories introduced in opensearch-project/security#6113.

Changes

  • _security/audit-logs/index.md: Added the two new categories to the tracked events table and documented that they are disabled by default on the transport layer with instructions on how to enable them.
  • _security/audit-logs/field-reference.md: Added field reference sections for both categories, including the audit_settings_changes array structure with sub-fields (setting, old_value, new_value, operation, scope). Updated the audit_category common attribute to list the new categories.

Issues Resolved

Documents opensearch-project/security#6113

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…NGED audit categories

Signed-off-by: Craig Perkins <cwperx@amazon.com>
@github-actions

Copy link
Copy Markdown

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference).

@github-actions github-actions Bot added the Tech review PR: Tech review in progress label Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tech review PR: Tech review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants