Skip to content

Conversation

@cwarnermm
Copy link
Member

Updates documentation to reflect v11.3 AdvancedLoggingJSON validation changes:

  • Add validation rules for standard vs audit logging configurations
  • Document error handling for invalid log level IDs
  • Update admin console references from "Audit logging (Beta)" to "Audit Logging"
  • Add troubleshooting guidance for configuration validation errors
  • Include warnings about v11.3 validation behavior in configuration examples

Addresses requirements from mattermost/mattermost#34414

Generated with Claude Code

- Add validation rules for standard vs audit logging configurations
- Document error handling for invalid log level IDs
- Update admin console references from Audit logging (Beta) to Audit Logging
- Add troubleshooting guidance for configuration validation errors
- Include warnings about v11.3 validation behavior in configuration examples

Generated with Claude Code

Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
@github-actions
Copy link

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

.. note::

The ability to enable and configure audit logging is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`.
The ability to enable and configure audit logging is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`. From Mattermost v11.3, the admin console displays "Audit Logging" instead of "Audit logging (Beta)", though the feature remains in beta status.
Copy link
Member Author

Choose a reason for hiding this comment

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

@hanzei - Is this true?

Copy link
Contributor

Choose a reason for hiding this comment

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

No it's not. Audit Logging is in Beta and marked as such in the UI

:start-after: :nosearch:

By default, Mattermost doesnt write audit logs locally to a file on the server, and the ability to enable audit logging in Mattermost is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`.
By default, Mattermost doesn't write audit logs locally to a file on the server, and the ability to enable audit logging in Mattermost is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`. From Mattermost v11.3, the admin console displays "Audit Logging" instead of "Audit logging (Beta)", though the feature remains in beta status.
Copy link
Member Author

Choose a reason for hiding this comment

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

Flagging this second instance

@cwarnermm cwarnermm requested a review from hanzei January 20, 2026 15:32
@cwarnermm cwarnermm added 1: Dev Review Requires review by a core commiter Guidance labels Jan 20, 2026
| enable_caller | string | Enables output of the file and line number that emitted a log record. Default is ``false``. |
+---------------+----------+----------------------------------------------------------------------------------------------+

Configuration validation
Copy link
Member Author

Choose a reason for hiding this comment

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

@hanzei - Looking forward to your input on the level of detail we want here

Copy link
Contributor

Choose a reason for hiding this comment

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

We can delete this whole section.

Copy link
Contributor

Choose a reason for hiding this comment

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

On a more meta note: Can we give Claude clearer instructions on how to write the docs? I wonder if we can come up with clearer guide lines.

@github-actions
Copy link

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

.. note::

The ability to enable and configure audit logging is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`.
The ability to enable and configure audit logging is currently in :ref:`Beta <administration-guide/manage/feature-labels:beta>`. From Mattermost v11.3, the admin console displays "Audit Logging" instead of "Audit logging (Beta)", though the feature remains in beta status.
Copy link
Contributor

Choose a reason for hiding this comment

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

No it's not. Audit Logging is in Beta and marked as such in the UI

Comment on lines 68 to 71
.. important::

From Mattermost v11.3, these standard logging configurations will be validated and will reject audit-specific log levels (``audit-api``, ``audit-content``, ``audit-permissions``, ``audit-cli``). For audit logging, use separate configurations with only audit levels. See the `Configuration validation <#configuration-validation>`__ section for details.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is the information above in L33 enough? Do we need to repeat it here?

| enable_caller | string | Enables output of the file and line number that emitted a log record. Default is ``false``. |
+---------------+----------+----------------------------------------------------------------------------------------------+

Configuration validation
Copy link
Contributor

Choose a reason for hiding this comment

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

We can delete this whole section.

| enable_caller | string | Enables output of the file and line number that emitted a log record. Default is ``false``. |
+---------------+----------+----------------------------------------------------------------------------------------------+

Configuration validation
Copy link
Contributor

Choose a reason for hiding this comment

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

On a more meta note: Can we give Claude clearer instructions on how to write the docs? I wonder if we can come up with clearer guide lines.

@cwarnermm
Copy link
Member Author

@hanzei - Clearer Claude prompts and guidance is in active development. I'd welcome any input or guidance you have to offer.

@github-actions
Copy link

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

@github-actions
Copy link

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

@cwarnermm cwarnermm requested a review from hanzei January 21, 2026 15:23
@github-actions
Copy link

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

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 Guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants