minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-25 17:22:39 +03:00
Code
docs/source/reference/deprecated/mc-admin-profile.rst
Daryl White 8b5be57ee3
Deprecated command cleanup (#1166) 
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes #1164

- Moves wildcard matching from `mc mirror` to `minio-mc.rst` page and
adds ref links throughout as needed.
2024-03-28 17:13:35 -04:00

4.1 KiB
Raw Permalink Blame History

mc admin profile

minio

Table of Contents

mc admin profile

Note

This command has been replaced by mc support profile as of mc RELEASE.2023-04-06T16-51-10Z.

Description

The mc admin profile command generates profiling data for debugging purposes.

Use mc admin on MinIO Deployments Only

Profile Data Format

mc admin profile produces a ZIP archive profile.zip that contains one or more .pprof files. Use the pprof go utility to read the profile data.

Examples

Profile Data for Single Resource

Use mc admin profile start with the ~mc admin profile start type flag to start profiling the resource:

mc admin profile start --type "TYPE" ALIAS
  • Replace ALIAS <mc admin profile start TARGET> with the alias <mc alias> of the MinIO host.
  • Replace TYPE <mc admin profile start type> with the resource to profile.

Use mc admin profile stop to stop profiling data from the specified resource and output the results:

mc admin profile stop

The command outputs the profiled data as profile.zip.

Profile Data for Multiple Resources

Use mc admin profile start with the ~mc admin profile start type flag to start profiling the resources:

mc admin profile start --type "TYPE,[TYPE...]" ALIAS
  • Replace ALIAS <mc admin profile start TARGET> with the alias <mc alias> of the MinIO host.
  • Replace TYPE <mc admin profile start type> with the resources to profile. Specify multiple resources as a comma-separated list.

Use mc admin profile stop to stop profiling data from the specified resources and output the results:

mc admin profile stop

The command outputs the profiled data as profile.zip.

Syntax

mc admin profile has the following syntax:

mc admin profile SUBCOMMAND

mc admin profile supports the following subcommands:

start

Starts collecting profiling data on the target MinIO deployment. The command has the following syntax:

mc admin profile start [FLAGS] TARGET

mc admin profile start supports the following arguments:

TARGET

The alias <mc alias> of a configured MinIO deployment from which the command collects profiling data.

type

The type(s) of profiling data to collect from the ~mc admin profile start TARGET MinIO deployment.

Specify one or more of the following supported types as a comma-separated list:

  • cpu
  • mem
  • block
  • mutex
  • trace
  • threads
  • goroutines

Defaults to cpu,mem,block if omitted.

stop

Stops the profiling process and returns the collected data as profile.zip. The zip file contains one or more .pprof files which are readable with programs like the go pprof utility.

The command has the following syntax:

mc admin profile stop TARGET

The command supports the following arguments:

TARGET

The alias <mc alias> of a configured MinIO deployment from which the command returns available profiling data.