Overhauled logging > replace audit-logging docs (#6813)

* Overhauled logging > replace audit-logging docs * Update source/manage/logging.rst Co-authored-by: Colton Shaw <[email protected]> * Update source/manage/logging.rst Co-authored-by: Colton Shaw <[email protected]> * Update source/manage/logging.rst Co-authored-by: Colton Shaw <[email protected]> * Incorporated reviewer feedback * Fixed broken table syntax * Update source/manage/logging.rst Co-authored-by: Doug Lauder <[email protected]> * Update source/manage/logging.rst Co-authored-by: Doug Lauder <[email protected]> * Update source/manage/logging.rst * Update source/manage/logging.rst * Update source/manage/logging.rst * Reworked FAQ, renamed audit page * Updated log file path --------- Co-authored-by: Colton Shaw <[email protected]> Co-authored-by: Doug Lauder <[email protected]> Co-authored-by: Stu Doherty <[email protected]>
mattermost · Dec 21, 2023 · 5d4c071 · 5d4c071
1 parent 9df21b9
commit 5d4c071
Show file tree

Hide file tree

Showing 8 changed files with 717 additions and 351 deletions.
diff --git a/source/about/editions-and-offerings.rst b/source/about/editions-and-offerings.rst
@@ -120,7 +120,7 @@ This offering includes all the features of Mattermost Professional, plus:
 - `Enhanced compliance with global and custom retention policies for messages and files </comply/data-retention-policy.html>`__.
 - `Granular administrative control with custom system admin roles </onboard/system-admin-roles.html>`__.
 - `Advanced configuration of playbook permissions, analytics dashboards, and channel exports </repeatable-processes/share-and-collaborate.html>`__.
-- `Enhanced compliance controls and granular audit logs with data export </comply/audit-log.html>`__.
+- `Enhanced compliance controls and granular audit logs with data export </manage/logging.html#audit-logging-experimental-beta>`__.
 - `Advanced collaboration with shared channels across Mattermost instances </onboard/shared-channels.html>`__.
 - `High availability support with multi-node database deployment </scale/high-availability-cluster.html>`__.
 - `Horizontal scaling through cluster-based deployment </scale/scaling-for-enterprise.html#cluster-based-deployment>`__.

diff --git a/source/comply/audit-log.rst → source/archive/audit-log.rst b/source/comply/audit-log.rst → source/archive/audit-log.rst
diff --git a/source/comply/embedded-json-audit-log-schema.rst b/source/comply/embedded-json-audit-log-schema.rst
@@ -1,4 +1,4 @@
-Embedded JSON audit log schema
+Audit Log JSON Schema
 ==============================
 
 .. include:: ../_static/badges/ent-selfhosted.rst
@@ -81,13 +81,13 @@ JSON data model
 |            |                              | Mattermost currently supports three log formats: plain, JSON, and `GELF <https://docs.graylog.org/docs/gelf>`__.                    |
 |            |                              |                                                                                                                                     |
 |            |                              | - Plain log format uses `RFC3339 <https://www.rfc-editor.org/rfc/rfc3339>`__ by default.                                            |
-|            |                              |   See the `plain log format configuration </comply/audit-log.html#plain-log-format-configuration-options>`__ documentation for      |
+|            |                              |   See the `plain log format configuration </manage/logging.html#plain-log-format-configuration-options>`__ documentation for        |
 |            |                              |   supported options.                                                                                                                |
 |            |                              | - JSON log format uses `RFC3339 <https://www.rfc-editor.org/rfc/rfc3339>`__ by default.                                             |
-|            |                              |   See the `JSON log format configuration </comply/audit-log.html#json-log-format-configuration-options>`__ documentation for        |
+|            |                              |   See the `JSON log format configuration </manage/logging.html#json-log-format-configuration-options>`__ documentation for          |
 |            |                              |   supported options.                                                                                                                |
 |            |                              | - GELF log format uses `unixtime <https://www.unixtimestamp.com/>`__.                                                               |
-|            |                              |   See the `GELF log format configuration </comply/audit-log.html#gelf-log-format-format-configuration-options>`__ documentation for |
+|            |                              |   See the `GELF log format configuration </manage/logging.html#gelf-log-format-configuration-options>`__ documentation for          |
 |            |                              |   supported options.                                                                                                                |
 +------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 | event_name | string                       | Unique name and identifier of the event type taking place (e.g. ``getLogs`` ``requestRenewalLink``,                                 |

diff --git a/source/conf.py b/source/conf.py
@@ -804,6 +804,8 @@ def setup(_: Sphinx):
         "https://docs.mattermost.com/comply/compliance-monitoring.html",
 "comply/cloud-data-retention-policy.html":
 	"https://docs.mattermost.com/comply/data-retention-policy.html",
+"comply/audit-log.html":
+        "https://docs.mattermost.com/manage/logging.html",
 
 # Configure redirects
 "configure/config-ssl-http2-apache2.html":
@@ -1752,6 +1754,20 @@ def setup(_: Sphinx):
 	"https://docs.mattermost.com/configure/authentication-configuration-settings.html#openid-connect-other-settings",
 "configure/experimental-configuration-settings.html#enable-app-bar":
         "https://docs.mattermost.com/configure/experimental-configuration-settings.html#disable-apps-bar",
+"configure/experimental-configuration-settings.html#syslog-configuration-options":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-ip":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-port":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-tag":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-cert":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-insecure":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
+"configure/experimental-configuration-settings.html#syslog-max-queue-size":
+        "https://docs.mattermost.com/manage/logging.html#syslog-target-configuration-options",
 
 # Deploy redirects
 "deploy/mobile-apps-faq.html":