mc admin scanner trace

The mc admin scanner trace command displays scanner-specific API operations occurring on the target MinIO AIStor deployment.

Syntax

The following example returns a list of API operations related to the scanner on the myaistor deployment.

mc admin scanner trace myaistor

The command has the following syntax:

mc admin scanner trace ALIAS                         \
                       [--filter-request]            \
                       [--filter-response]           \
                       [--filter-size <value>]       \
                       [--funcname <value>]          \
                       [--node <value>]              \
                       [--path <value>]              \
                       [--response-duration <value>] \
                       [--verbose, -v]

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required

The alias of the MinIO AIStor deployment for which to display scanner API operations.

--filter-request

Optional

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

Must be used with --filter-size flag.

--filter-response

Optional

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

Must be used with --filter-size flag.

--filter-size

Optional

Filter output to request sizes or response sizes greater than the specified size.

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

Valid units include:

Suffix	Unit Size
`k`	KB (Kilobyte, 1000 Bytes)
`m`	MB (Megabyte, 1000 Kilobytes)
`g`	GB (Gigabyte, 1000 Megabytes)
`t`	TB (Terabyte, 1000 Gigabytes)
`ki`	KiB (Kibibyte, 1024 Bytes)
`mi`	MiB (Mebibyte, 1024 Kibibytes)
`gi`	GiB (Gibibyte, 1024 Mebibytes)
`ti`	TiB (Tebibyte, 1024 Gibibytes)

--funcname

Optional

Returns calls for the entered function name.

--node

Optional

Returns calls for the specified server.

--path

Optional

Returns calls for the specified path.

--response-duration

Optional

Trace calls with response duration greater than the specified value.

--verbose

Alias: -v

Optional

Returns verbose output.

Examples

Monitor all scanner API operations

Use mc admin scanner trace to monitor scanner API operations on the MinIO AIStor deployment at the alias myaistor:

mc admin scanner trace myaistor

Show scanner trace for a specific path

Use mc admin scanner trace to monitor API operations for a the path my-bucket/my-prefix/* on the deployment at the myaistor alias:

 mc admin scanner trace --path my-bucket/my-prefix/* myaistor

Show scanner API operations for the `scanObject` function

Monitor scanner activity for the scanObject function on the myaistor deployment:

mc admin scanner trace --funcname=scanner.ScanObject myaistor

Show scanner operation requests greater than `1MB` in size

Use mc admin scanner trace to monitor requests larger than a 1MB on the myaistor deployment:

mc admin scanner trace --filter-request --filter-size 1MB myaistor

Show scanner operation responses greater than `1MB` in size

Use mc admin scanner trace to monitor large response sizes:

 mc admin scanner trace --filter-response --filter-size 1MB myaistor

mc admin scanner trace

On this page