You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove unused audit log file rotation settings from docs (#8771)
* Remove unused audit log file rotation settings from docs
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>
* Remove FileMaxQueueSize from ExperimentalAuditSettings docs (v11.6)
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 <Combs7th@users.noreply.github.com>
* Delete source/administration-guide/manage/telemetry.rst
* Update environment-configuration-settings.rst
* Restore telemetry.rst; remove only the 5 deprecated ExperimentalAuditSettings fields
The page documents features (Security Alerts, Error & Diagnostic Reporting)
still present in v11.6. Full deletion was out of PR scope. Only removes
FileMaxSizeMB, FileMaxAgeDays, FileMaxBackups, FileCompress, FileMaxQueueSize
from the telemetry enumeration list, matching the server-side removal in
mattermost/mattermost#35170.
Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
* Remove audit logging settings duplicated in environment config settings page
* Update logging.rst
---------
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
Co-authored-by: Eric Sethna <14333569+esethna@users.noreply.github.com>
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.
Review and manage the following :ref:`experimental <administration-guide/manage/feature-labels:experimental>` configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Experimental > Features**:
8
8
9
9
- `Experimental System Console configuration settings <#experimental-system-console-configuration-settings>`__
:description: Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost Cloud deployment.
776
-
777
-
Advanced logging
778
-
~~~~~~~~~~~~~~~~
779
-
780
-
.. include:: ../../_static/badges/entry-ent.rst
781
-
:start-after::nosearch:
782
-
783
-
Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost Cloud deployment. See the :ref:`advanced logging <administration-guide/manage/logging:advanced logging>` documentation for details about logging options.
:description: Write audit files locally for a self-hosted deployment.
791
-
792
-
Enable audit logging
793
-
~~~~~~~~~~~~~~~~~~~~~
794
-
795
-
.. include:: ../../_static/badges/ent-plus.rst
796
-
:start-after::nosearch:
797
-
798
-
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.
799
-
800
-
**True**: Audit logging files are enabled, and audit files are written locally to a file for a self-hosted deployment.
801
-
802
-
**False**: Audit logging files aren't enabled, and audit logs aren't written locally to a 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``). |
:displayname: File max size MB (Audit Logging > Self-Hosted)
829
-
:systemconsole: Experimental > Features
830
-
:configjson: FileMaxSizeMB
831
-
:environment: N/A
832
-
: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.
833
-
834
-
Max file size
835
-
~~~~~~~~~~~~~
836
-
837
-
.. include:: ../../_static/badges/ent-plus.rst
838
-
:start-after::nosearch:
839
-
840
-
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``.
:displayname: File max age days (Audit Logging > Self-Hosted)
848
-
:systemconsole: Experimental > Features
849
-
:configjson: FileMaxAgeDays
850
-
:environment: N/A
851
-
: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.
852
-
853
-
Max file age
854
-
~~~~~~~~~~~~~
855
-
856
-
.. include:: ../../_static/badges/ent-plus.rst
857
-
:start-after::nosearch:
858
-
859
-
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.
:displayname: File max backups (Audit Logging > Self-Hosted)
867
-
:systemconsole: Experimental > Features
868
-
:configjson: FileMaxBackups
869
-
:environment: N/A
870
-
: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.
871
-
872
-
Maximum file backups
873
-
~~~~~~~~~~~~~~~~~~~~
874
-
875
-
.. include:: ../../_static/badges/ent-plus.rst
876
-
:start-after::nosearch:
877
-
878
-
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.
:displayname: File max queue size (Audit Logging > Self-Hosted)
905
-
:systemconsole: Experimental > Features
906
-
:configjson: FileMaxQueueSize
907
-
:environment: N/A
908
-
: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.
909
-
910
-
Maximum file queue
911
-
~~~~~~~~~~~~~~~~~~~
912
-
913
-
.. include:: ../../_static/badges/ent-plus.rst
914
-
:start-after::nosearch:
915
-
916
-
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.
917
-
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.
:description: Cloud Enterprise customers can upload and manage a certificate for audit logging encryption on Syslog or TCP logging targets.
929
-
930
-
Certificate
931
-
~~~~~~~~~~~~
932
-
933
-
Cloud Enterprise customers can upload and manage a certificate for audit logging encryption on Syslog or TCP logging targets. The ability to upload a certificate is only available when the feature flag ``ExperimentalAuditSettingsSystemConsoleUI`` is enabled.
934
-
935
-
Upload the certificate PEM file in the System Console by going to **System Console > Audit Log Settings > Certificate** and selecting **File/Remove Certificate**. The certificate file can be stored in the filestore or stored locally on the filesystem.
:description: Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost self-hosted deployment.
943
-
944
758
Experimental configuration settings for self-hosted deployments only
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments