Skip to content

Update docs for System Statistics label #8915

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.

Sign up for GitHub

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

Open
marianunez wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs for System Statistics label #8915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions source/administration-guide/configure/reporting-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@ Reporting configuration settings

View the following statistics for your overall deployment and specific teams, as well as access server logs, in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Reporting**:

- `Site statistics <#site-statistics>`__
- `System statistics <#system-statistics>`__
- `Team statistics <#team-statistics>`__
- `Server logs <#server-logs>`__
- `Statistics configuration settings <#statistics-configuration-settings>`__

----

Site statistics
.. _site-statistics:

System statistics
---------------
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Editor Evie — Blocker: The section title underline is shorter than the title ("System statistics" / "---------------"), which will break reStructuredText rendering for this page. Suggestion: extend the underline to at least the title length (17+ dashes).

Suggested change
---------------
-----------------

Copilot uses AI. Check for mistakes.

+----------------------------------------------------------------+---------------------------------------------------------------------+
| View statistics on a wide variety of activities in Mattermost, | - System Config path: **Reporting > Site Statistics** |
| View statistics on a wide variety of activities in Mattermost, | - System Config path: **Reporting > System Statistics** |
| including: users, seats, teams, channels, posts, calls, | - ``config.json setting``: N/A |
| sessions, commands, webhooks, websocket and database | - Environment variable: N/A |
| connections, and collaborative playbooks. | |
Expand Down
2 changes: 1 addition & 1 deletion source/administration-guide/manage/admin/installing-license-key.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You don't need to wait for your current license key to expire before replacing i

.. tip::

To review license usage before uploading a new key, go to **System Console > Reporting > Site Statistics**. The **Total Activated Users** field shows the primary paid seat count used for license validation. Review **Single-channel Guests** separately because guests in exactly one channel are tracked outside the primary paid seat count, are free up to a 1:1 ratio with licensed seats, and generate warnings instead of hard enforcement when that allowance is exceeded.
To review license usage before uploading a new key, go to **System Console > Reporting > System Statistics**. The **Total Activated Users** field shows the primary paid seat count used for license validation. Review **Single-channel Guests** separately because guests in exactly one channel are tracked outside the primary paid seat count, are free up to a 1:1 ratio with licensed seats, and generate warnings instead of hard enforcement when that allowance is exceeded.

Follow these steps to change your license key:

Expand Down
6 changes: 3 additions & 3 deletions source/administration-guide/manage/statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Statistics on users, posts, and channels are tracked for each system and team. E

For advanced metrics for Entry, Enterprise, and Enterprise deployments, :doc:`see performance monitoring documentation to learn more </administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring>`.

Site statistics
System statistics
---------------
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Editor Evie — Blocker: The section title underline is shorter than the title ("System statistics" / "---------------"), which will cause reStructuredText parsing/build errors. Suggestion: extend the underline to at least the same length as the title (e.g., use 17+ dashes to match "System statistics").

Suggested change
---------------
-----------------

Copilot uses AI. Check for mistakes.

System statistics are viewable under **System Console > Reporting**. The data shown here is a cumulative sum across all teams on the system.
Expand Down Expand Up @@ -140,12 +140,12 @@ To enable team admins to access their team's statistics:
.. image:: ../../images/edit-viewer-system-admin-role.png
:alt: Enable team admins to access their team's statistics in the System Console by going to User Management > System Roles, and making changes to the Viewer role.

2. Under **Privileges**, expand the **Reporting** section, set **Team Statistics** to **Read only**, then set **Site Statistics** and **Server Logs** to **No access**.
2. Under **Privileges**, expand the **Reporting** section, set **Team Statistics** to **Read only**, then set **System Statistics** and **Server Logs** to **No access**.

3. Set all other privileges to **No access** to restrict all users with the **Viewer** role to access only the **Team Statistics** page in the System Console.

.. image:: ../../images/restrict-role-access.png
:alt: On the Viewer page, restrict user access to the Team Statistics page by expanding the Reporting section, setting Site Statistics and Server Logs to No Access, and setting all other privileges to No Access.
:alt: On the Viewer page, restrict user access to the Team Statistics page by expanding the Reporting section, setting System Statistics and Server Logs to No Access, and setting all other privileges to No Access.

4. Under **Assigned People**, select **Add People** to assign team admins to the **Viewer** role, and enable them to access their team's statistics.

Expand Down
2 changes: 1 addition & 1 deletion source/administration-guide/onboard/delegated-granular-administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Privileges
| About | - PERMISSION_SYSCONSOLE_READ_ABOUT_EDITION_AND_LICENSE |
| | - PERMISSION_SYSCONSOLE_WRITE_ABOUT_EDITION_AND_LICENSE |
+------------------------+--------------------------------------------------------------------------+
| Reporting | **Site Statistics** |
| Reporting | **System Statistics** |
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Veteran Vince — Friction: The UI label was updated to System Statistics, but the documented permission constants remain "...SITE_STATISTICS". Quoted: "System Statistics" next to "PERMISSION_SYSCONSOLE*_REPORTING_SITE_STATISTICS". Why it matters: admins scripting role changes may assume the permission names were renamed too and have trouble finding the right constants. Suggestion: add a brief note here that the permission constant names retain the legacy "SITE_STATISTICS" wording even though the UI page is now labeled "System Statistics".

Suggested change
| Reporting | **System Statistics** |
| Reporting | **System Statistics** |
| | Note: Permission constants retain the legacy |
| | ``..._SITE_STATISTICS`` naming. |

Copilot uses AI. Check for mistakes.
| | - PERMISSION_SYSCONSOLE_READ_REPORTING_SITE_STATISTICS |
| | - PERMISSION_SYSCONSOLE_WRITE_REPORTING_SITE_STATISTICS |
| | |
Expand Down
2 changes: 1 addition & 1 deletion source/product-overview/self-hosted-subscriptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ We'll send you an email notice around the end of the quarter reminding you to se

If you have more total activated users than you purchased in your annual subscription, your Customer Success Manager will provide you with a true-up quote for the new users added. The additional invoice will be pro-rated based on the number of months left in your subscription term, including the months for the calendar quarter for the time you pull the report. Mattermost won't provide downward adjustments. Mattermost will invoice based on Mattermost’s `current list prices <https://mattermost.com/pricing/>`_.

A system admin must take a screenshot of the **System Console > Reporting > Site Statistics** page and send it to Mattermost in an email.
A system admin must take a screenshot of the **System Console > Reporting > System Statistics** page and send it to Mattermost in an email.

- Please ensure your screenshot is taken from the top of the page and includes **Total Activated Users**, **Single-channel Guests**, and **Monthly Active Users**.
- Please include the date of the screenshot in the file name.
Expand Down
2 changes: 1 addition & 1 deletion source/product-overview/subscription.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Guests are billed based on channel access:

Bots, deactivated users, and synthetic users in :doc:`Microsoft Teams integrations </end-user-guide/collaborate/collaborate-within-connected-microsoft-teams>` and :doc:`connected workspace </administration-guide/onboard/connected-workspaces>` users aren't counted towards the total number of activated users.

You can review your activated user count in **System Console > Site Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Novice Nate — Friction: This navigation path differs from other pages updated in this PR (which use System Console > Reporting > System Statistics). Quoted: "System Console > System Statistics". Why it matters: readers may not find the page if they follow an inconsistent path. Suggestion (minimal): change to System Console > Reporting > System Statistics for consistency with the rest of the docs.

Suggested change
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 21, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use the full navigation path for consistency and accuracy.

Line 100 likely omits the intermediate Reporting level. For consistency with the rest of this PR, use System Console > Reporting > System Statistics.

Suggested minimal diff 
-You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
+You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.

Based on learnings: "Describe Mattermost feature behavior, UI labels, and capability boundaries accurately."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@source/product-overview/subscription.rst` at line 100, Update the navigation
path string "System Console > System Statistics" to include the intermediate
Reporting level so it reads "System Console > Reporting > System Statistics"
while keeping the references to "Total Activated Users" and "Single-channel
Guests" unchanged; modify the sentence in the subscription.rst content that
currently contains "System Console > System Statistics" to the new full path for
consistency with other docs.


Do I need to pay for deactivated users?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading