mc admin trace

Description

The mc admin trace command displays API operations occurring on the target MinIO deployment.

Examples

Monitor All API operations

Use mc admin trace to monitor API operations on a MinIO deployment:

mc admin trace -a ALIAS

• Replace ALIAS with the alias of the MinIO deployment.

See Calls that Return 503 Errors

Use mc admin trace to monitor API operations that return a service unavailable 503 error:

mc admin trace -v --status-code 503 ALIAS

• Replace ALIAS with the alias of the MinIO deployment.

See Console Trace for a Path

Use mc admin trace to monitor activity for a specific path:

mc admin trace --path my-bucket/my-prefix/* ALIAS

• Replace ALIAS with the alias of the MinIO deployment.
• Replace my-bucket/my-prefix/* with the bucket, prefix, and object name or wildcard you wish to trace.

See Console Trace for a Response Size Greater than 1Mb

Use mc admin trace to monitor responses over a specific size:

mc admin trace --filter-response --filter-size 1Mb ALIAS

• Replace ALIAS with the alias of the MinIO deployment.
• Replace 1Mb with the desired response size.

See Console Trace for a Request Operation Durations Greater than 5ms

Use mc admin trace to monitor long operations:

mc admin trace --filter-duration --filter-size 5ms ALIAS

• Replace ALIAS with the alias of the MinIO deployment.

Syntax

mc admin trace has the following syntax:

mc admin trace [FLAGS] TARGET

mc admin trace supports the following argument:

TARGET

mc-cmd

Specify the alias of a configured MinIO deployment for which to monitor API operations.

--all, a

mc-cmd

Returns all traffic on the MinIO deployment, including internode traffic between MinIO servers.

--call

mc-cmd

Traces only matching client operation or call types. For example, the following command only traces operations of the type scanner.

mc admin trace --call scanner TARGET

Valid call types include:

• batch-keyrotation
• batch-replication
• bootstrap
• decommission
• ftp
• healing
• ilm
• internal
• os
• rebalance
• replication-resync
• s3
• scanner
• storage

If not specified, MinIO returns call types of s3.

--errors, e

mc-cmd

Returns failed API operations only.

--filter-request

mc-cmd

Trace client operations or calls with request size greater than the specified --filter-size value.

Must be used with --filter-size flag.

--filter-response

mc-cmd

Trace client operations or calls with response size greater than the specified --filter-size value.

Must be used with --filter-size flag.

--filter-size

mc-cmd

Size limit of a filtered client operation or call.

Must be used with either --filter-request or --filter-response flag.

Valid units include:

--funcname

mc-cmd

Returns calls for the entered function name.

--method

mc-cmd

Returns call of the specified HTTP method.

--node

mc-cmd

Returns calls for the specified server.

--path

mc-cmd

Returns calls for the specified path.

--request-header

mc-cmd

Returns calls matching the supplied request header.

--request-query

mc-cmd

Returns calls matching the supplied request query parameter. This debug option should only be used at the direction of MinIO Support.

--response-duration

mc-cmd

Trace calls with response duration greater than the specified value.

--response-threshold

mc-cmd

Takes a time string as a value, such as 5ms. Returns only calls with a response time greater than the supplied threshold.

If not specified, MinIO returns calls with a response time greater than 5ms.

--status-code

mc-cmd

Returns calls of the specified HTTP status code.

--stats

mc-cmd

Accumulates aggregated statistics for each traced function call during the current trace session.

The output table includes the following columns.

Accumulate stats, such as name, count, duration, min time, max time, time to first byte, or errors. Accumulates up to 15 stat entries.

--verbose

mc-cmd

Returns verbose output.

Global Flags

This command supports any of the global flags.