Documentation

Documentation

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.

SUBNET Registration Required

The mc support commands are designed for MinIO deployments registered with MinIO SUBNET to ensure optimal outcome of diagnostics and performance testing. Deployments not registered with SUBNET cannot use the mc support commands.

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]      \
                         [--airgap]    \
                         [--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.

--airgap
Optional

Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).

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

ALIAS
Required

The alias of the MinIO deployment.

Global Flags

This command supports any of the global flags.