Skip to content

AI-Aided: Add documentation for Load Metric field in About dialog #8103

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

Merged
merged 7 commits into from
Jun 20, 2025

Conversation

cwarnermm
Copy link
Member

@cwarnermm cwarnermm commented Jun 20, 2025

This PR adds documentation for the new Load Metric field that will be visible in the About > Mattermost dialog starting from Mattermost server v10.10 via mattermost/mattermost#30700

Changes

  • Created new documentation file: source/collaborate/view-system-information.rst

    • Documents how users access the About dialog via profile menu
    • Explains information displayed in the About dialog
    • Documents the new Load Metric field for v10.10+
  • Updated messaging collaboration guide: source/guides/messaging-collaboration.rst

    • Added new documentation to table of contents
    • Added descriptive summary for the functionality

Load Metric Field

The Load Metric field reflects server activity levels and is used by Mattermost support teams as a reference point when assisting with deployments, particularly when support packets or site statistics cannot be shared externally.

Closes #8101

Generated with Claude Code

- Create new documentation file for viewing system information
- Document the About dialog accessible via profile menu
- Add Load Metric field documentation for Mattermost v10.10+
- Update messaging collaboration guide to include new documentation
- Load Metric provides contextual server activity data for support

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Jun 20, 2025
Copy link

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

@cwarnermm cwarnermm changed the title Add documentation for Load Metric field in About dialog AI-Aided: Add documentation for Load Metric field in About dialog Jun 20, 2025
Copy link

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

Load metric
------------

From Mattermost v10.10, system admins have access to an additional diagnostic data point when working with Mattermost support by going to the **Product** menu |product-list| and selecting **About Mattermost**.
Copy link
Member

Choose a reason for hiding this comment

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

This information is not limited to system admins: it's intentionally exposed to any regular user of the system.


From Mattermost v10.10, system admins have access to an additional diagnostic data point when working with Mattermost support by going to the **Product** menu |product-list| and selecting **About Mattermost**.

The **Load Metric** field displays current server activity levels and usage patterns, giving Mattermost support teams a contextual reference point for understanding deployment characteristics without requiring access to detailed logs, configurations, or sensitive system data. System admins may need to reference this value when working with Mattermost support teams in environments where Support Packet generation is restricted or prohibited.
Copy link
Member

Choose a reason for hiding this comment

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

I'm wondering if we shouldn't just be explicit that we're computing a monthly active users metric relative to the total number of licensed users?

Comment on lines 24 to 27
- **Mattermost Version**: The current version of the Mattermost server
- **Database Schema Version**: The version of the database schema in use
- **License**: Information about your Mattermost license (if applicable)
- **Build Information**: Details about the server build
Copy link
Member

Choose a reason for hiding this comment

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

Should we add the load metric in this list?

@cwarnermm
Copy link
Member Author

@claude - Incorporate @lieut-data's inline feedback, and ensure that the source/collaborate/view-system-information.rst source file is accessible in the left-hand nav pane

Copy link
Contributor

claude bot commented Jun 20, 2025

Claude finished @cwarnermm's task —— View job


I've successfully incorporated @lieut-data's inline feedback and verified the navigation structure for the new documentation file.

Completed Tasks:

  • Read repository setup instructions (CLAUDE.md)
  • Read current state of changed files
  • Address review feedback from @lieut-data
    • Fix admin-only language to include all users
    • Be more explicit about MAU metric calculation
    • Add load metric to the About dialog information list
  • Investigate navigation structure (file is properly linked in toctree)
  • Commit changes to PR branch

Changes Made:

  1. Fixed admin-only language: Changed "system admins have access" to "all users have access" in generating-support-packet.rst:192
  2. Made metric more explicit: Updated Load Metric description to specify "monthly active users relative to the total number of licensed users" in generating-support-packet.rst:194
  3. Added Load Metric to About dialog list: Added "Load Metric: Monthly active users relative to licensed users (from v10.10+)" to view-system-information.rst:28

Navigation Structure:

The source/collaborate/view-system-information.rst file is properly included in the navigation hierarchy:

  • Main index.rstEnd User Guide (use-mattermost.rst) → Messaging Collaboration (messaging-collaboration.rst) → View system information (view-system-information.rst)

The file should be accessible in the left-hand nav pane under: End User GuideMessaging CollaborationView system information

All review feedback has been addressed and changes committed to the PR branch. The documentation should build and display correctly with the updated navigation structure.


claude bot and others added 2 commits June 20, 2025 18:55
… definition, and add load metric to About dialog list

- Change "system admins have access" to "all users have access" for load metric visibility
- Specify load metric as "monthly active users relative to licensed users" for clarity
- Add Load Metric field to the About dialog information list in view-system-information.rst

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

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

Copy link

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

Copy link

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

Copy link

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

@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 2: Editor Review Requires review by an editor labels Jun 20, 2025
@cwarnermm cwarnermm merged commit 8de081a into master Jun 20, 2025
4 checks passed
@cwarnermm cwarnermm deleted the claude/issue-8101-20250620_164143 branch June 20, 2025 19:52
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add license load metric endpoint and UI indicator
2 participants