Skip to content

Remove unused audit log file rotation settings from docs#8771

Open
Combs7th wants to merge 1 commit intomasterfrom
claude/issue-8769-20260304-2307
Open

Remove unused audit log file rotation settings from docs#8771
Combs7th wants to merge 1 commit intomasterfrom
claude/issue-8769-20260304-2307

Conversation

@Combs7th
Copy link
Copy Markdown
Contributor

@Combs7th Combs7th commented Mar 5, 2026

Remove four unused audit log file rotation settings from documentation to reflect Mattermost server v11.4+ behavior.

Engineering PR mattermost/mattermost#35170 removes these settings from ExperimentalAuditSettings:

  • FileMaxSizeMB
  • FileMaxAgeDays
  • FileMaxBackups
  • FileCompress

File rotation for audit logs is now configured via AdvancedLoggingJSON.

Closes #8769

Generated with Claude Code

From Mattermost server v11.4, the following ExperimentalAuditSettings
file rotation settings were removed as unused (mattermost/mattermost#35170):
- FileMaxSizeMB
- FileMaxAgeDays
- FileMaxBackups
- FileCompress

File rotation for audit logs is now configured via AdvancedLoggingJSON.

Updated files:
- environment-configuration-settings.rst: Remove 4 rotation setting sections
- experimental-configuration-settings.rst: Remove 4 rotation setting sections;
  update description to direct admins to AdvancedLoggingJSON for file rotation
- logging.rst: Remove rotation settings from Cloud defaults list
- telemetry.rst: Remove rotation settings from telemetry data list

Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
@Combs7th Combs7th requested a review from hanzei March 5, 2026 00:37
@Combs7th Combs7th changed the base branch from master to v11.5-documentation March 5, 2026 00:37
@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor Guidance labels Mar 5, 2026
@Combs7th Combs7th added this to the v11.5.0 milestone Mar 5, 2026
@Combs7th
Copy link
Copy Markdown
Contributor Author

Combs7th commented Mar 5, 2026

@hanzei - Tagging you for dev review. Do the changes above look accurate? If so, I'll tag Eric for editor review.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 5, 2026

Newest code from mattermost has been published to preview environment for Git SHA f141ce0

@amyblais
Copy link
Copy Markdown
Member

amyblais commented Mar 5, 2026

@Combs7th This is also scheduled for v11.6 (April release).

@Combs7th Combs7th modified the milestones: v11.5.0, v11.6.0 Mar 5, 2026
@Combs7th Combs7th changed the base branch from v11.5-documentation to master March 5, 2026 07:19
@amyblais amyblais added the Do Not Merge Should not be merged until this label is removed label Mar 5, 2026
Copy link
Copy Markdown
Contributor

@hanzei hanzei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

:start-after: :nosearch:

When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, compression, maximium age to manage file rotation, and timestamps for audit logging, as defined below. You can specify these settings independently for audit events and AD/LDAP events.
When audit logging is enabled in a self-hosted instance, you can specify a file name and queue size for audit logging, as defined below. To configure file rotation for audit logs, use the :ref:`AdvancedLoggingJSON <administration-guide/configure/environment-configuration-settings:output audit logs to multiple targets>` setting. You can specify these settings independently for audit events and AD/LDAP events.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure that you can set the queue side without advanced logging?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't do telemetry any longer. Can we just drop the file?

@Combs7th
Copy link
Copy Markdown
Contributor Author

Combs7th commented Apr 6, 2026

@claude - Please revise the docs update based on the PR evidence and developer feedback.

Before drafting:

  • Treat the engineering PR as the source of truth.
  • Note that the PR removes five unused ExperimentalAuditSettings fields, not four:
  • FileMaxSizeMB
  • FileMaxAgeDays
  • FileMaxBackups
  • FileCompress
  • FileMaxQueueSize
  • Do not say that queue size can still be configured separately unless you find explicit docs-repo evidence for that.
  • Point admins to AdvancedLoggingJSON for audit log file rotation / advanced audit log output behavior.
  • Keep scope focused on correcting inaccurate admin config docs.
  • Do not modify changelogs, upgrade notes, version archive, deprecated/removed features, or unsupported releases.
  • Do not make a decision to delete the experimental docs file unless you find explicit evidence in the docs repo that it is obsolete.

What to do:

  • Identify the existing docs pages/sections that still document these removed ExperimentalAuditSettings fields.
  • Update those pages to remove or rewrite the outdated settings.
  • Replace any inaccurate wording so it does not imply FileMaxQueueSize is still supported there.
  • Add a short admin-facing note pointing readers to AdvancedLoggingJSON for audit log rotation and advanced output configuration.
  • Keep the update minimal, accurate, and aligned to Mattermost server v11.6.

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Apr 6, 2026

Claude encountered an error —— View job


I'll analyze this and get back to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor Do Not Merge Should not be merged until this label is removed Guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove unused audit log file rotation settings

3 participants