mc support profile

Table of Contents

Description

The mc support profile command runs a system profile for your deployment. The results of the profile can provide insight into the MinIO server process running on a given node.

The resulting report is intended for use by MinIO Engineering. You can upload the report to MinIO SUBNET. Independent or third-party use of these profiles for diagnostics and remediation is done at your own risk.

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.

Examples

Fetch CPU Profiling

This command retrieves the CPU profile on a MinIO deployment with the alias minio1. The profile runs for the default of 10 seconds.

mc support profile --type cpu minio1/

Fetch CPU, Memory, and Block Profiling Concurrently

This command fetches the profile of the CPU, memory, and block usage on the alias minio2. The profile runs for the default of 10 seconds.

mc support profile --type cpu,mem,block minio2/

Fetch CPU, Memory, and Block Profiling Concurrently for 10 Minutes

This command fetches the profile of the CPU, memory, and block on the alias minio3. The profile runs for 10 minutes (600 seconds).

mc support profile --type cpu,mem,block --duration 600 minio3/

Syntax

The mc support profile command has the following syntax:

mc [GLOBALFLAGS] support profile    \
                         COMMAND    \
                         [--type]   \
                         [--duration]
                         ALIAS

Parameters

--duration
Optional

Run profiling for the specified duration in seconds.

Use --type <value> where <value> is the number of seconds for the profile to run.

If not specified, the command collects data for 10 seconds.

--type
Optional

Specify the profile(s) to gather data for.

Use --type <value> where <value> is one or more comma-separated types of data to collect.

Valid types are:

  • cpu

  • cpuio

  • mem

  • block

  • mutex

  • trace

  • threads

  • goroutines

If not specified, the command collects data for CPU, memory, block, mutex, threads, and goroutines.

ALIAS
Required

The alias of the MinIO deployment.

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.