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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions source/collaborate/view-system-information.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
View system information
======================

.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

You can view technical details about your Mattermost server, including version information and system metrics. This information is useful when working with Mattermost support or troubleshooting issues.

.. tab:: Web/Desktop

1. Select your profile picture in the top-right corner of Mattermost.
2. Select **About Mattermost** from the dropdown menu.

.. tab:: Mobile

1. Tap your profile picture.
2. Tap **About** to view system information.

About dialog information
------------------------

The About dialog displays key information about your Mattermost instance, including:

- **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
- **Load Metric**: Monthly active users relative to licensed users (:ref:`learn more <manage/admin/generating-support-packet:load metric>`)
2 changes: 2 additions & 0 deletions source/guides/messaging-collaboration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance
Organize using custom user groups </collaborate/organize-using-custom-user-groups>
Invite people </collaborate/invite-people>
Learn about Mattermost roles </collaborate/learn-about-roles>
View system information </collaborate/view-system-information>
Collaborate within channels </collaborate/collaborate-within-channels>
Communicate with messages and threads </collaborate/communicate-with-messages>
Collaborate within Microsoft Teams </collaborate/collaborate-within-connected-microsoft-teams>
Expand All @@ -32,6 +33,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance
* :doc:`Organize using custom user groups </collaborate/organize-using-custom-user-groups>` - Learn about creating and managing custom user groups in Mattermost.
* :doc:`Invite people to your workspace </collaborate/invite-people>` - Learn how to add new users to Mattermost and add users to existing teams and channels.
* :doc:`Learn about Mattermost user roles </collaborate/learn-about-roles>` - Learn about the 6 user roles in Mattermost and what they can do.
* :doc:`View system information </collaborate/view-system-information>` - View technical details about your Mattermost server, including version information and system metrics.
* :doc:`Collaborate within channels </collaborate/collaborate-within-channels>` - Learn how to get started collaborating within Mattermost channels.
* :doc:`Communicate with messages and threads </collaborate/communicate-with-messages>` Learn how to get started collaborating within Mattermost channels.
* :doc:`Collaborate within Microsoft Teams </collaborate/collaborate-within-connected-microsoft-teams>` - Learn how to get started collaborating within Microsoft Teams.
Expand Down
13 changes: 10 additions & 3 deletions source/manage/admin/generating-support-packet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Generate
---------

.. important::

Before generating a Support Packet, go to **System Console > Environment > Logging** and ensure **Output logs to file** is set to **true**, and set **File Log Level** to **DEBUG**.

.. tab:: Web/Desktop
Expand Down Expand Up @@ -143,11 +143,11 @@ From Mattermost v9.11, generated Support Packets include a ``metadata.yaml`` fil
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------+----------------------------+
| license_id | Optional | Unique identifier of the current server's license. | abcdejisd67yigqhmkz4ho1234 |
| | | Expected to be 26 characters or longer. | |
| | | This field is empty when theres no license. | |
| | | This field is empty when there's no license. | |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------+----------------------------+
| customer_id | Optional | The id of the customer, as defined in the license file. | a1b2c3d4qbbr5cpkbpbmef123h |
| | | Expected to be 26 characters or longer. | |
| | | Empty when theres no license. | |
| | | Empty when there's no license. | |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------+----------------------------+
| extras | Optional | Key/value of any additional information, specific to the plugin/component that generated the file. | |
| | | Can be useful for identifying the contents of the data. | |
Expand Down Expand Up @@ -185,3 +185,10 @@ The Support Packet contains 3 go runtime profiling files:
These files can be read using `pprof <https://golang.google.cn/cmd/pprof/>`_.

Use ``go tool pprof -web X`` to open a visualization of the profile in your browser, replacing ``X`` with the profile's file name.

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

Mattermost v10.10 introduces an additional diagnostic data point under the **Product Menu > About Mattermost** popup.

The Load Metric field displays monthly active users relative to the total number of licensed users, giving Mattermost support teams a contextual reference point for understanding deployment active usage for troubleshooting and guidance. It isn’t a comprehensive performance monitoring tool or health indicator, but serves as a supplementary data point when traditional diagnostic methods aren’t available.