Skip to content

Remove unused audit log file rotation settings from docs #8771

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
Combs7th wants to merge 6 commits into
base: master
Choose a base branch
from
+12 −203
Open

Remove unused audit log file rotation settings from docs #8771

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f141ce0
Remove unused audit log file rotation settings from docs
github-actions[bot] Mar 4, 2026
5df6d13
Remove FileMaxQueueSize from ExperimentalAuditSettings docs (v11.6)
github-actions[bot] Apr 9, 2026
4af6ca7
Delete source/administration-guide/manage/telemetry.rst
Combs7th Apr 9, 2026
8d482b4
Update environment-configuration-settings.rst
Combs7th Apr 15, 2026
403699c
Merge branch 'master' into claude/issue-8769-20260304-2307
esethna Apr 17, 2026
1d0a041
Restore telemetry.rst; remove only the 5 deprecated ExperimentalAudit…
github-actions[bot] Apr 18, 2026
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
92 changes: 1 addition & 91 deletions source/administration-guide/configure/environment-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3589,97 +3589,7 @@ Audit file name

.. note::

The file name must be set to `enable <#auditlog-fileenabled>`__ audit logging.

.. config:setting:: auditlog-filemaxsizemb
:displayname: Maximum audit file size (Audit Logging)
:systemconsole: Compliance > Audit Logging
:configjson: .ExperimentalAuditSettings.FileMaxSizeMB
:environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB
:description: The maximum size in megabytes for audit log files before they are rotated. Default is 100 MB.

Maximum file size
^^^^^^^^^^^^^^^^^

+--------------------------------------------------+----------------------------------------------------------------------------------------+
| The maximum size in megabytes for audit log | - System Config path: **Compliance > Audit Logging** |
| files before they are rotated. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxSizeMB`` > ``100`` |
| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB`` |
| Numerical input. Default is **100** MB. | |
+--------------------------------------------------+----------------------------------------------------------------------------------------+

.. config:setting:: auditlog-filemaxagedays
:displayname: Maximum audit file age (Audit Logging)
:systemconsole: Compliance > Audit Logging
:configjson: .ExperimentalAuditSettings.FileMaxAgeDays
:environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS
:description: The maximum age in days for audit log files before they are deleted. Default is 0 (no limit).

Maximum file age
^^^^^^^^^^^^^^^^

+--------------------------------------------------+----------------------------------------------------------------------------------------+
| The maximum age in days for audit log files | - System Config path: **Compliance > Audit Logging** |
| before they are deleted. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxAgeDays`` > ``0`` |
| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS`` |
| Numerical input. Default is **0** (no limit). | |
+--------------------------------------------------+----------------------------------------------------------------------------------------+

.. config:setting:: auditlog-filemaxbackups
:displayname: Maximum audit file backups (Audit Logging)
:systemconsole: Compliance > Audit Logging
:configjson: .ExperimentalAuditSettings.FileMaxBackups
:environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS
:description: The maximum number of audit log file backups to retain. Default is 0 (no limit).

Maximum file backups
^^^^^^^^^^^^^^^^^^^^

+--------------------------------------------------+----------------------------------------------------------------------------------------+
| The maximum number of audit log file backups | - System Config path: **Compliance > Audit Logging** |
| to retain. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxBackups`` > ``0`` |
| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS`` |
| Numerical input. Default is **0** (no limit). | |
+--------------------------------------------------+----------------------------------------------------------------------------------------+

.. config:setting:: auditlog-filecompress
:displayname: Compress audit log files (Audit Logging)
:systemconsole: Compliance > Audit Logging
:configjson: .ExperimentalAuditSettings.FileCompress
:environment: MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS
:description: Whether to compress rotated audit log files.

- **true**: Rotated audit log files are compressed.
- **false**: **(Default)** Rotated audit log files aren't compressed.

Compress audit log files
^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------------------------------+-------------------------------------------------------------------------------------------+
| Whether to compress rotated audit log files. | - System Config path: **Compliance > Audit Logging** |
| | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileCompress`` > ``false`` |
| - **true**: Rotated audit log files are | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS`` |
| compressed. | |
| - **false**: **(Default)** Rotated audit log | |
| files aren't compressed. | |
+--------------------------------------------------+-------------------------------------------------------------------------------------------+

.. config:setting:: auditlog-filemaxqueuesize
:displayname: Audit log queue size (Audit Logging)
:systemconsole: Compliance > Audit Logging
:configjson: .ExperimentalAuditSettings.FileMaxQueueSize
:environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE
:description: The maximum number of audit log entries that can be queued. Default is 1000.

Audit log queue size
^^^^^^^^^^^^^^^^^^^^

+--------------------------------------------------+--------------------------------------------------------------------------------------------+
| The maximum number of audit log entries that | - System Config path: **Compliance > Audit Logging** |
| can be queued. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxQueueSize`` > ``1000`` |
| | - 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.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

.. config:setting:: auditlog-certificate
:displayname: Audit log certificate (Audit Logging)
Expand Down
98 changes: 1 addition & 97 deletions source/administration-guide/configure/experimental-configuration-settings.rst
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@hanzei hanzei Apr 21, 2026

Choose a reason for hiding this comment

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

Why are the audit settings documented on two pages?

Copy link
Copy Markdown
Contributor

@esethna esethna Apr 21, 2026

Choose a reason for hiding this comment

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

My guess is that they were never removed from the experimental pages when the feature was promoted? @hanzei are you open to submitted a follow-up PR to correct this based on the current feature state?

Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ Enable audit logging
.. include:: ../../_static/badges/ent-plus.rst
: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 for audit logging, as defined below. 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. You can specify these settings independently for audit events and AD/LDAP events.

**True**: Audit logging files are enabled, and audit files are written locally to a file for a self-hosted deployment.

Expand Down Expand Up @@ -796,102 +796,6 @@ Specify the path to the audit file for a self-hosted deployment.
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileName": ""`` with string input consisting of a user-defined path (e.g. ``/var/log/mattermost_audit.log``). |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: max-file-size
:displayname: File max size MB (Audit Logging > Self-Hosted)
:systemconsole: Experimental > Features
:configjson: FileMaxSizeMB
:environment: N/A
:description: This is the maximum size (measured in megabytes) that the file can grow before triggering rotation for a self-hosted deployment.. Default is **100** MB.

Max file size
~~~~~~~~~~~~~

.. include:: ../../_static/badges/ent-plus.rst
:start-after: :nosearch:

This is the maximum size, in megabytes, that the file can grow before triggering rotation for a self-hosted deployment. The default setting is ``100``.

+---------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxSizeMB": 100`` with numerical input. |
+---------------------------------------------------------------------------------------------------------------------+

.. config:setting:: max-file-age
:displayname: File max age days (Audit Logging > Self-Hosted)
:systemconsole: Experimental > Features
:configjson: FileMaxAgeDays
:environment: N/A
:description: This is the maximum age in days a file can reach before triggering rotation for a self-hosted deployment.. The default value is **0**, indicating no limit on the age.

Max file age
~~~~~~~~~~~~~

.. include:: ../../_static/badges/ent-plus.rst
:start-after: :nosearch:

This is the maximum age, in days, a file can reach before triggering rotation for a self-hosted deployment. The default value is ``0``, indicating no limit on the age.

+--------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxAgeDays": 0`` with numerical input. |
+--------------------------------------------------------------------------------------------------------------------+

.. config:setting:: maximum-file-backups
:displayname: File max backups (Audit Logging > Self-Hosted)
:systemconsole: Experimental > Features
:configjson: FileMaxBackups
:environment: N/A
:description: This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is **0**, indicating no limit on the number of backups.

Maximum file backups
~~~~~~~~~~~~~~~~~~~~

.. include:: ../../_static/badges/ent-plus.rst
:start-after: :nosearch:

This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is ``0``, indicating no limit on the number of backups.

+--------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxBackups": 0`` with numerical input. |
+--------------------------------------------------------------------------------------------------------------------+

.. config:setting:: file-compression
:displayname: File compress (Audit Logging > Self-Hosted)
:systemconsole: Experimental > Features
:configjson: FileCompress
:environment: N/A
:description: When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. Default value is **false**.

File compression
~~~~~~~~~~~~~~~~

.. include:: ../../_static/badges/ent-plus.rst
:start-after: :nosearch:

When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment.

+-------------------------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileCompress": false`` with options ``true`` and ``false``. |
+-------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: maximum-file-queue
:displayname: File max queue size (Audit Logging > Self-Hosted)
:systemconsole: Experimental > Features
:configjson: FileMaxQueueSize
:environment: N/A
:description: This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. Default is **1000** records.

Maximum file queue
~~~~~~~~~~~~~~~~~~~

.. include:: ../../_static/badges/ent-plus.rst
:start-after: :nosearch:

This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. The default is ``1000`` records.
This setting can be left as default unless you are seeing audit write failures in the server log and need to adjust the number accordingly.

+-------------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxQueueSize": 1000`` with numerical input. |
+-------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: audit-logging-certificate
:displayname: Audit logging certificate upload (Audit Logging > Cloud Enterprise)
:systemconsole: Audit Log Settings > Certificate
Expand Down
7 changes: 1 addition & 6 deletions source/administration-guide/manage/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,14 +235,9 @@ You can enable and customize advanced audit logging in Mattermost to record acti
.. note::

- From Mattermost v10.11, Cloud deployments include certificate-based audit logging capabilities not available within self-hosted deployments.
- Cloud-based deployments use the following self-hosted audit logging default values:
- Cloud-based deployments use the following self-hosted audit logging default values:

- FileEnabled: false
- FileMaxSizeMB: 100
- FileMaxAgeDays: 0 (no limit)
- FileMaxBackups: 0 (retain all)
- FileCompress: false
- FileMaxQueueSize: 1000

- Cloud deployments can't configure local file-based audit logging, and all file-related settings are hidden.

Expand Down
Loading
Loading