-
Notifications
You must be signed in to change notification settings - Fork 609
v11.3: Validate log levels in AdvancedLoggingJSON #8653
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.
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
base: master
Are you sure you want to change the base?
Conversation
- 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>
|
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hanzei - Is this true?
There was a problem hiding this comment.
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 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>`. | ||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Flagging this second instance
| | enable_caller | string | Enables output of the file and line number that emitted a log record. Default is ``false``. | | ||
| +---------------+----------+----------------------------------------------------------------------------------------------+ | ||
|
|
||
| Configuration validation |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
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. |
There was a problem hiding this comment.
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
| .. 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. | ||
|
|
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
|
@hanzei - Clearer Claude prompts and guidance is in active development. I'd welcome any input or guidance you have to offer. |
|
Newest code from mattermost has been published to preview environment for Git SHA f08de76 |
|
Newest code from mattermost has been published to preview environment for Git SHA 1a68923 |
|
Newest code from mattermost has been published to preview environment for Git SHA 863a81d |
Updates documentation to reflect v11.3 AdvancedLoggingJSON validation changes:
Addresses requirements from mattermost/mattermost#34414
Generated with Claude Code