Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,12 @@ Contents of a Support Packet
The contents of a Mattermost Support Packet can differ by server version. Select the tab that corresponds to your Mattermost version to see the files included in the Support Packet.

.. tab:: v11.0 and later
:parse-titles:

**Cluster-wide files (root directory):**
Cluster-wide files
~~~~~~~~~~~~~~~~~~

The following cluster-wide files are located in the root directory of the Support Packet:

- `metadata.yaml <#metadata>`__
- ``plugins.json`` (all active and inactive plugins)
Expand All @@ -78,22 +82,10 @@ The contents of a Mattermost Support Packet can differ by server version. Select
- ``warning.txt`` (present when issues are encountered during packet generation)
- ``tsdb_dump.tar.gz`` (present when the Metrics plugin is installed and the **Performance metrics** option is selected when generating the Support Packet)

From Mattermost v11, Support Packet generation includes connection testing for configured :doc:`enterprise search engines </administration-guide/scale/enterprise-search>`, including both :doc:`Elasticsearch </administration-guide/scale/elasticsearch-setup>` and :doc:`AWS OpenSearch </administration-guide/scale/opensearch-setup>`. Any connection errors encountered during this testing are included in the Support Packet to help diagnose enterprise search configuration issues. When enterprise search is configured, the Support Packet includes connection test results and any errors encountered:

- **Elasticsearch connection test**: Tests server connectivity and reports server version, installed plugins, and any connection errors
- **AWS OpenSearch connection test**: Tests server connectivity and reports server version, installed plugins, and any connection errors

Example Elasticsearch diagnostic output included in the Support Packet:
Cluster-specific files
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: yaml

elastic:
server_version: 8.9.0
server_plugins:
- analysis-icu
error: 'Elasticsearch.checkMaxVersion: Failed to get elasticsearch server version., an error happened during the Info query execution: dial tcp 127.0.0.1:9200: connect: connection refused'

**Cluster-specific files (in node subdirectories):**
The following cluster-specific files are located in node subdirectories:

- ``<node-id>/mattermost.log`` (Mattermost logs for each node)
- ``<node-id>/audit.log`` (Mattermost audit logs for each node)
Expand All @@ -103,7 +95,20 @@ The contents of a Mattermost Support Packet can differ by server version. Select
- ``<node-id>/heap.prof`` (`Go performance metrics <#go-performance-metrics>`__ for each node)
- ``<node-id>/goroutines`` (`Go performance metrics <#go-performance-metrics>`__ for each node)

The following additional plugin diagnostic data is included in the generated Support Packet when the plugin is enabled and operational:
Enterprise search
~~~~~~~~~~~~~~~~~~

From Mattermost v11.2, the Support Packet ``diagnostics.yaml`` file includes connection testing for configured :doc:`enterprise search engines </administration-guide/scale/enterprise-search>`, including both :doc:`Elasticsearch </administration-guide/scale/elasticsearch-setup>` and :doc:`AWS OpenSearch </administration-guide/scale/opensearch-setup>`. Any connection errors encountered during testing are included to help diagnose enterprise search configuration issues.

SAML provider type
~~~~~~~~~~~~~~~~~~~

From Mattermost v11.2, the Support Packet ``diagnostics.yaml`` file includes SAML provider details to help administrators and support teams quickly identify the SAML Identity Provider (IdP) in use and provides additional diagnostic context for troubleshooting authentication issues. When SAML SSO is configured, SAML details include provider type, provider-specific diagnostic information to accelerate troubleshooting of SAML authentication flows, and relevant metadata about the SAML provider to help identify common configuration patterns and potential issues.

Plugin diagnostic data
~~~~~~~~~~~~~~~~~~~~~~~

The following additional plugin diagnostic data is available when the plugin is enabled and operational:

- GitHub: ``/github/diagnostics.yaml``
- GitLab: ``/com.github.manland.mattermost-plugin-gitlab/diagnostics.yaml``
Expand Down