docs/source/reference/minio-mc/mc-support-diag.rst

mc support diag

minio

Table of Contents

mc support diag

Command History

The command used to create the diagnostic report has changed over time.

MinIO Client Release	Command	Notes
RELEASE.2020-10-03T02-54-56Z	mc admin health	First available
RELEASE.2020-11-17T00-39-14Z	mc admin subnet health	Command made a SUBNET subcommand
RELEASE.2022-02-13T23-26-13Z	mc support diag	Command moved to mc support

Description

The mc support diag command generates a health report for a MinIO deployment.

For deployments registered with the MinIO subscription network (|subnet-short|), the command generates and uploads the health report for analysis. Optionally, automate generating and uploading the report every 24 hours by enabling ~mc support callhome.

The resulting health report is intended for use by MinIO Engineering via SUBNET and may contain internal or private data points. Exercise caution before sending a health report to a third party or posting the health report in a public forum.

MinIO recommends that you run the health diagnostics when first provisioning the cluster and again at any failure scenario.

Use the mc support diag command to trigger the diagnostic test. For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports.

For airgapped or firewalled environments, or other environments that prevent direct network access from the deployment, you can save the report locally with the ~mc support diag --airgap flag. After saving, you can then upload the results of the test to SUBNET manually.

Sample Output

● Admin Info ... ✔ 
● CPU ... ✔ 
● Disk Hardware ... ✔ 
● Os Info ... ✔ 
● Mem Info ... ✔ 
● Process Info ... ✔ 
● Config ... ✔ 
● Drive ... ✔ 
● Net ... ✔ 
*********************************************************************************
                                WARNING!!
     ** THIS FILE MAY CONTAIN SENSITIVE INFORMATION ABOUT YOUR ENVIRONMENT ** 
     ** PLEASE INSPECT CONTENTS BEFORE SHARING IT ON ANY PUBLIC FORUM **
*********************************************************************************
mc: Health data saved to dc-11-health_20220511053323.json.gz

The gzipped output contains the requested health information.

Examples

Generate Health Data for a Cluster and Automatically Upload to SUBNET

Generate health data for a MinIO cluster and automatically for a MinIO cluster at alias minio1 for transmission to SUBNET.

mc support diag minio1

The automatic upload of data only occurs for deployments registered with SUBNET using mc license register.

Generate Health Data for a Cluster to Upload Manually

Generate a diagnostic report for a MinIO deployment at alias minio2 and save it for manual upload to SUBNET:

mc support diag minio2 --airgap

1. Run the command to download the .gzip file
2. Login to https://subnet.min.io and select the Deployments section
3. Select the deployment for the report
4. Select the Upload button
5. Drag and drop the file or browse to the .gzip file location to upload it

Syntax

The command has the following syntax:

mc [GLOBALFLAGS] support diag                \
                         ALIAS               \
                         [--airgap]          \
                         [--api-key string]

Parameters

ALIAS

The alias <alias> of the MinIO deployment.

--airgap

Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration). Generates the diagnostic report and saves it to the location where you ran the command.

You must manually upload the report to SUBNET.

For instructions, see the airgap example <minio-support-diagnostics-airgap>.

If the deployment is airgapped, but the local device where you are using the minio client <minio-client> has network access, you do not need to use the --airgap flag.

--api-key

Takes the account's API key value from SUBNET.

This value is only required for airgapped environments where MinIO has not already stored the API key for the deployment.

Global Flags