Skip to content
This repository was archived by the owner on Sep 17, 2026. It is now read-only.

v11.3: Validate log levels in AdvancedLoggingJSON #8652

Closed

Description

@cwarnermm

@claude - Let’s update the Mattermost Product Documentation to reflect the System Admin AdvancedLoggingJSON configuration and audit logging settings product experience from Mattermost server vv11.3 onward captured via mattermost/mattermost#34414

Scope & constraints (include non-editable docs list):
Scope: document AdvancedLoggingJSON validation rules for standard vs audit logging and the admin console label change for Audit Logging; focus on config and admin UI behavior only.
Constraints: DO NOT modify changelogs, important upgrade notes, version archive, removed/deprecated features, or unsupported legacy releases.
Required doc touchpoints:
Identify likely pages for server logging configuration, AdvancedLoggingJSON examples, and audit logging settings (admin console and config.json).
Update any admin console settings labels or screenshots/text referring to “Audit logging (Beta)” where applicable.
Persona-separated tasks (System Admin only):
Explain that AdvancedLoggingJSON validation now enforces valid log level IDs and rejects audit levels in standard logging, and standard levels in audit logging; include “what changed/why/how to fix” guidance and common error symptoms (validation errors for invalid level IDs).
Clarify that audit logging uses audit-specific levels only (audit-api, audit-content, audit-permissions, audit-cli) and that standard logging rejects these levels, based on new validation behavior.
Note the admin console label change from “Audit logging (Beta)” to “Audit Logging” while beta status remains (isBeta flag), and update any UI references accordingly.
Output requirements:
Provide a list of pages/sections to update.
Provide proposed doc text snippets (before/after or insert-ready).
If PR review not possible: milestone not found in PR evidence (summary.json); a human must validate milestone/version if needed.

Activity

  1. claude commented on Jan 19, 2026

    @claude
    Contributor

    Claude finished @cwarnermm's task —— View job • claude/issue-8652-20260119-1755 • Create PR ➔


    Mattermost v11.3 AdvancedLoggingJSON Documentation Updates Complete

    I've successfully updated the Mattermost Product Documentation to reflect the System Admin AdvancedLoggingJSON configuration and audit logging settings changes from v11.3.

    Todo List:

    • Read repository setup instructions (CLAUDE.md)
    • Research existing logging documentation in the codebase
    • Review key files for AdvancedLoggingJSON and audit logging references
    • Document new validation rules for standard vs audit logging
    • Add error handling guidance for invalid log level IDs
    • Update admin console label references from "Audit logging (Beta)" to "Audit Logging"
    • Update documentation with v11.3 validation behavior
    • Test build/lint processes
    • Commit and push changes

    Changes Made

    1. Enhanced Validation Documentation (source/administration-guide/manage/logging.rst):

    • Added comprehensive section on v11.3 configuration validation
    • Documented separation between standard and audit log levels
    • Added troubleshooting guidance for common validation errors
    • Included warnings in configuration examples about new validation behavior

    2. Admin Console Label Updates:

    • Updated references from "Audit logging (Beta)" to "Audit Logging"
    • Clarified that the feature remains in beta status despite the label change
    • Updated both main logging documentation and experimental settings

    3. Error Handling Guidance:

    • Documented common validation error messages
    • Provided step-by-step troubleshooting instructions
    • Explained proper log level ID usage for different configurations

    Key Documentation Updates

    Validation Rules:

    • Standard logging configurations reject audit levels (audit-api, audit-content, audit-permissions, audit-cli)
    • Audit logging configurations reject standard levels (debug, info, warn, error, etc.)
    • Validation occurs at startup and when updating settings

    Common Error Messages:

    • Invalid log level 'audit-api' for standard logging target
    • Invalid log level 'info' for audit logging target
    • Unknown log level ID

    Files Updated:

    • source/administration-guide/manage/logging.rst (primary logging documentation)
    • source/administration-guide/configure/experimental-configuration-settings.rst (experimental audit settings)

  2. esethna commented on Sep 14, 2026

    @esethna
    Contributor

    Bulk closing issues as our docs have migrated to the /mattermost repository. Please considering opening your issue or PR there if it is still valid.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions