docs/source/reference/minio-mc-admin/mc-admin-scanner-trace.rst

mc admin scanner trace

minio

Table of Contents

mc admin scanner trace

Description

The mc admin scanner trace command displays scanner <minio-concepts-scanner>-specific API operations occurring on the target MinIO deployment.

Use mc admin on MinIO Deployments Only

EXAMPLE

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

mc admin scanner trace myminio

SYNTAX

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]

Parameters

ALIAS

The alias <alias> of the MinIO deployment for which to display scanner <minio-concepts-scanner> API operations.

--filter-request

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

Must be used with ~mc admin scanner trace --filter-size flag.

--filter-response

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

Must be used with ~mc admin scanner trace --filter-size flag.

--filter-size

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

Must be used with either ~mc admin scanner trace --filter-request or ~mc admin scanner trace --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 (Terrabyte, 1000 Gigabytes)
ki	KiB (Kibibyte, 1024 Bites)
mi	MiB (Mebibyte, 1024 Kibibytes)
gi	GiB (Gibibyte, 1024 Mebibytes)
ti	TiB (Tebibyte, 1024 Gibibytes)

--funcname

Returns calls for the entered function name.

--node

Returns calls for the specified server.

--path

Returns calls for the specified path.

--response-duration

Trace calls with response duration greater than the specified value.

--verbose, -v

Returns verbose output.

Global Flags

Examples

Monitor all scanner API operations

Use mc admin scanner trace to monitor scanner <minio-concepts-scanner> API operations on the MinIO deployment at the alias myminio:

mc admin scanner trace myminio

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 myminio alias:

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

Show scanner API operations for the scanObject function

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

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

Show scanner operation requests greater than 1MB in size

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

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

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 myminio 

Show scanner operations that last longer than five milliseconds

Use mc admin scanner trace to monitor long operations:

mc admin scanner trace --response-duration 5ms myminio