Skip to content

Remove unused audit log file rotation settings from docs#8771

Open
Combs7th wants to merge 3 commits intomasterfrom
claude/issue-8769-20260304-2307
Open

Remove unused audit log file rotation settings from docs#8771
Combs7th wants to merge 3 commits 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 <[email protected]>
@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?

@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.

@Combs7th
Copy link
Copy Markdown
Contributor Author

Combs7th commented Apr 9, 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 9, 2026

Claude finished @Combs7th's task in 2m 57s —— View job


Revised audit log docs — all 5 removed fields addressed

  • Read CLAUDE.md for repo-specific guidelines
  • Read changed files to understand current state
  • Identify all sections documenting the 5 removed ExperimentalAuditSettings fields
  • Update environment-configuration-settings.rst — removed FileMaxQueueSize section, expanded existing note to point to AdvancedLoggingJSON for file rotation and advanced output
  • Update experimental-configuration-settings.rst — fixed intro text (was "file name and queue size", now "file name only"), removed FileMaxQueueSize section
  • Update logging.rst — removed FileMaxQueueSize: 1000 from cloud defaults list
  • Update telemetry.rst — removed enum FileMaxQueueSize from ExperimentalAuditSettings telemetry list
  • Commit and push changes

Summary of changes (commit 5df6d13):

File Change
environment-configuration-settings.rst Removed FileMaxQueueSize section; expanded the audit file name note to include: "To configure file rotation and advanced audit log output, use the AdvancedLoggingJSON setting."
experimental-configuration-settings.rst Fixed intro text (removed "and queue size"); removed Maximum file queue section
logging.rst Removed FileMaxQueueSize: 1000 from cloud default values list
telemetry.rst Removed enum FileMaxQueueSize from ExperimentalAuditSettings telemetry list

The previous PR commit had removed the 4 rotation settings (FileMaxSizeMB, FileMaxAgeDays, FileMaxBackups, FileCompress) but missed FileMaxQueueSize in all locations. All 5 fields are now removed in alignment with mattermost/mattermost#35170.
|

Also remove FileMaxQueueSize from all doc locations:
- environment-configuration-settings.rst: remove queue size section,
  add AdvancedLoggingJSON pointer note
- experimental-configuration-settings.rst: fix intro text (was
  "file name and queue size", now "file name only"), remove queue
  size section
- logging.rst: remove FileMaxQueueSize from cloud defaults list
- telemetry.rst: remove enum FileMaxQueueSize from ExperimentalAuditSettings

Aligns with mattermost/mattermost#35170 which removes 5 fields from
ExperimentalAuditSettings: FileMaxSizeMB, FileMaxAgeDays,
FileMaxBackups, FileCompress, FileMaxQueueSize.

Co-authored-by: Combs7th <[email protected]>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 84352809-c408-4984-aff1-aa1a4ec89bf0

📥 Commits

Reviewing files that changed from the base of the PR and between 5df6d13 and 4af6ca7.

📒 Files selected for processing (1)
  • source/administration-guide/manage/telemetry.rst
💤 Files with no reviewable changes (1)
  • source/administration-guide/manage/telemetry.rst

📝 Walkthrough

Walkthrough

Removed documentation for deprecated self-hosted audit log file rotation settings across configuration pages and updated guidance to direct users to AdvancedLoggingJSON for file rotation and advanced audit-log output. The Telemetry administration guide file was deleted entirely.

Changes

Cohort / File(s) Summary
Audit Log — environment config
source/administration-guide/configure/environment-configuration-settings.rst
Removed auditlog-filemaxsizemb, auditlog-filemaxagedays, auditlog-filemaxbackups, auditlog-filecompress, and auditlog-filemaxqueuesize config docs; added note directing file rotation/advanced audit output to AdvancedLoggingJSON.
Audit Log — experimental config
source/administration-guide/configure/experimental-configuration-settings.rst
Removed max-file-size, max-file-age, maximum-file-backups, file-compression, and maximum-file-queue entries; retained only file-name guidance and pointed to AdvancedLoggingJSON.
Logging reference
source/administration-guide/manage/logging.rst
Removed default file-related parameters for self-hosted audit logging in Cloud reference, leaving only FileEnabled: false.
Telemetry guide
source/administration-guide/manage/telemetry.rst
Deleted the entire Telemetry administration guide file and its detailed telemetry enumerations and descriptions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses issue #8769's main objectives: assessing the necessity of docs updates and identifying/updating admin documentation pages referencing removed audit log settings. However, the deletion of telemetry.rst appears unrelated to the linked issue's scope. The telemetry.rst deletion contradicts the PR's stated focus and the linked issue's guidance to limit scope to correcting inaccurate admin config docs about audit log rotation. Remove this out-of-scope file deletion.
Out of Scope Changes check ⚠️ Warning The deletion of source/administration-guide/manage/telemetry.rst is out of scope. The linked issue #8769 focuses on removing audit log file rotation settings documentation, not removing telemetry documentation entirely. Remove the deletion of telemetry.rst as it is unrelated to the audit log file rotation settings removal objective specified in issue #8769.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Remove unused audit log file rotation settings from docs' clearly and directly summarizes the main change—removal of deprecated audit log file rotation configuration settings documentation.
Description check ✅ Passed The description is related to the changeset and explains the purpose: removing audit log file rotation settings documentation to reflect Mattermost v11.4+ behaviour, with reference to the engineering PR and related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-8769-20260304-2307

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
source/administration-guide/manage/telemetry.rst (1)

1-1: ⚠️ Potential issue | 🟡 Minor

Consider broader telemetry documentation strategy.

A previous review comment indicates telemetry is no longer collected ("We don't do telemetry any longer"). Additionally, the changes to this file (removing individual ServiceSettings enumeration fields) appear outside the stated PR scope of removing audit log rotation settings documentation.

Before merging, clarify whether:

  1. The entire telemetry file should be deprecated/removed rather than maintained
  2. These enum field removals are intentional or accidentally included in this PR
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@source/administration-guide/manage/telemetry.rst` at line 1, The telemetry
docs currently state telemetry is not collected and the diff shows removals from
the ServiceSettings enumeration that fall outside the audit-log-rotation scope;
confirm whether the telemetry page
(source/administration-guide/manage/telemetry.rst) should be fully
deprecated/removed or retained, and if retained revert or remove only the
unrelated enum-field edits (references to ServiceSettings enum fields) so this
PR only contains audit log rotation doc changes; update the PR with either a
removal commit for the telemetry file or a revert/adjustment of the
ServiceSettings field deletions and add a short commit message explaining the
chosen action.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@source/administration-guide/configure/environment-configuration-settings.rst`:
- Line 3592: The sentence that currently reads as an absolute requirement should
be narrowed to apply only when using the FileEnabled/file-output audit logging
path: update the phrasing around the "enable <#auditlog-fileenabled>`__ audit
logging" reference so it explicitly says the file name must be set when using
the FileEnabled (file output) audit logger; leave references to
AdvancedLoggingJSON and ExperimentalAuditSettings.FileName untouched but note
that those targets may not require ExperimentalAuditSettings.FileName. Target
the text around the "enable <#auditlog-fileenabled>" link and mention
"FileEnabled/file-output path" and "ExperimentalAuditSettings.FileName" so
readers understand the requirement is scoped to the file-output configuration
only.

---

Duplicate comments:
In `@source/administration-guide/manage/telemetry.rst`:
- Line 1: The telemetry docs currently state telemetry is not collected and the
diff shows removals from the ServiceSettings enumeration that fall outside the
audit-log-rotation scope; confirm whether the telemetry page
(source/administration-guide/manage/telemetry.rst) should be fully
deprecated/removed or retained, and if retained revert or remove only the
unrelated enum-field edits (references to ServiceSettings enum fields) so this
PR only contains audit log rotation doc changes; update the PR with either a
removal commit for the telemetry file or a revert/adjustment of the
ServiceSettings field deletions and add a short commit message explaining the
chosen action.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2372fab4-159b-42bd-94e7-6267364f6e57

📥 Commits

Reviewing files that changed from the base of the PR and between a35fec9 and 5df6d13.

📒 Files selected for processing (4)
  • source/administration-guide/configure/environment-configuration-settings.rst
  • source/administration-guide/configure/experimental-configuration-settings.rst
  • source/administration-guide/manage/logging.rst
  • source/administration-guide/manage/telemetry.rst

| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE`` |
| Numerical input. Default is **1000**. | |
+--------------------------------------------------+--------------------------------------------------------------------------------------------+
The file name must be set to `enable <#auditlog-fileenabled>`__ audit logging. To configure file rotation and advanced audit log output, use the :ref:`AdvancedLoggingJSON <administration-guide/configure/environment-configuration-settings:output audit logs to multiple targets>` setting.
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.

⚠️ Potential issue | 🟡 Minor

Clarify filename requirement scope for audit logging.

Line 3592 currently states that file name must be set to enable audit logging. That reads as absolute, but audit logging can be configured via AdvancedLoggingJSON targets where ExperimentalAuditSettings.FileName may not be required. Please scope this requirement to the FileEnabled/file-output path only.

Suggested wording
-  The file name must be set to `enable <#auditlog-fileenabled>`__ audit logging. To configure file rotation and advanced audit log output, use the :ref:`AdvancedLoggingJSON <administration-guide/configure/environment-configuration-settings:output audit logs to multiple targets>` setting.
+  When `output audit logs to file <#auditlog-fileenabled>`__ is enabled, the file name must be set. To configure file rotation and advanced audit log output, use the :ref:`AdvancedLoggingJSON <administration-guide/configure/environment-configuration-settings:output audit logs to multiple targets>` setting.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@source/administration-guide/configure/environment-configuration-settings.rst`
at line 3592, The sentence that currently reads as an absolute requirement
should be narrowed to apply only when using the FileEnabled/file-output audit
logging path: update the phrasing around the "enable <#auditlog-fileenabled>`__
audit logging" reference so it explicitly says the file name must be set when
using the FileEnabled (file output) audit logger; leave references to
AdvancedLoggingJSON and ExperimentalAuditSettings.FileName untouched but note
that those targets may not require ExperimentalAuditSettings.FileName. Target
the text around the "enable <#auditlog-fileenabled>" link and mention
"FileEnabled/file-output path" and "ExperimentalAuditSettings.FileName" so
readers understand the requirement is scoped to the file-output configuration
only.

@Combs7th
Copy link
Copy Markdown
Contributor Author

Combs7th commented Apr 9, 2026

@hanzei - Is this looking more accurate now?

@Combs7th Combs7th requested a review from hanzei April 9, 2026 22:46
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

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

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