mc support diagnostics

Table of Contents

Description

The mc support diagnostics command generates a health report for a MinIO deployment. For deployments registered with the MinIO subscription network (SUBNET), the command can automatically upload the health report for analysis.

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.

This diagnostic test runs as a one-shot test and can run for as long as 5 minutes. During the test, MinIO freezes all S3 calls and queues read or write operations until the test completes. The queue is limited based on the supported maximum concurrent requests per host. Requests that exceed this limit on a given host return a 503 error after ~10 seconds.

Use the mc support diagnostics 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 --airgap flag. After saving, you can then upload the results of the test to SUBNET manually.

Note

The mc support commands were designed for MinIO deployments registered with MinIO SUBNET to ensure optimal outcome of diagnostics and performance testing. MinIO does not guarantee any functionality if used against non-MinIO deployments or if used independently of MinIO engineering and support.

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 support 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]

Parameters

ALIAS
Required

The alias of the MinIO deployment.

--airgap
Optional

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.

Global Flags

--debug
Optional

Enables verbose output to the console.

For example:

mc --debug COMMAND
--config-dir
Optional

The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON
Optional

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND
--no-color
Optional

Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet
Optional

Suppresses console output.

--insecure
Optional

Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version
Optional

Displays the current version of mc.

--help
Optional

Displays a summary of command usage on the terminal.