mc support telemetry record

The mc support telemetry record command streams captured trace calls to a file. Use the --sample flag to modify the number of calls traced and adjust the impact on performance.

In addition to creating a file with the telemetry data, the command outputs the number of packets saved, the file name and path, and instructions for uploading the generated file to SUBNET.

You can replay a recorded file and stream the telemetry to an OpenTelemetry Protocol (OTLP)-compatible collector by HTTP interface with mc support telemetry replay. You can also analyze the recorded file locally with an interactive terminal interface using mc support telemetry analyze.

Syntax

mc support telemetry record myaistor

mc [GLOBALFLAGS] support telemetry record           \
                             ALIAS                  \
                             [--duration integer] \
                             [--func string]      \
                             [--incoming]           \
                             [--out string]       \
                             [--pubkey string]    \
                             [--sample string]    \
                             [--type "string"]      \
                             [--unencrypted]
                             

Parameters

ALIAS

Required

The full path to the alias, prefix, or object where the command should run. The path must include at least an ALIAS.

--duration

Optional

Number of seconds after which to stop streaming telemetry. If not specified, it defaults to 0 and continues to record until stopped.

--func

Optional

Capture traces only on calls that match the specified substring.

For example, --func=PutObject, to capture traces only on PutObject calls.

--incoming

Optional

Trace incoming requests that include OpenTelemetry headers.

--out

Optional

The path to use to store the captured telemetry information.

If not specified, outputs to the file metrics-<datetime>. The file extension is .enc unless using the --unencrypted flag, where the file extension is .bin instead.

--pubkey

Optional

Path to the public key to use for encrypting the recorded telemetry file.

If not provided, and the --unencrypted flag is not used, the command encrypts the file with the MinIO AIStor public certificate.

Mutually exclusive with --unencrypted.

--sample

Optional

A fraction, percentage, or float between 0 and 1 of the portion of calls to trace. Higher sample rates result in greater impacts on system performance.

For example 1/10, 25% or 0.1.

If not specified, returns data for all calls (100%).

--type

Optional

Include trace data for only the specified type(s) of traces. If not specified, defaults to s3.

Repeat the flag to specify more than one type. A comma-separated list is read as a single unrecognized type, and the command falls back to s3.

Valid types are:

Capitalization is ignored when specifying trace types.

--unencrypted

Optional

Save telemetry to an unencrypted file.

Mutually exclusive with --pubkey.

Global flags

This command supports any of the global flags.

Examples

Capture S3 events from the myaistor server and store it encrypted

The following command captures streams S3 calls on the server at the alias myaistor. The output is stored as an encrypted file to the local folder with the name metrics-<datetime>.enc. The capturing of traces continues until manually stopped.

mc support telemetry record myaistor

Capture 1 in every 25 PutObject calls from the myaistor cluster over 1 minute

The following command captures PutObject calls on the myaistor server. It only captures every 25th call. The command runs for 1 minute (60 seconds).

The results output to the local folder as an encrypted file with the name metrics-<datetime>.enc.

mc support telemetry record myaistor --func=PutObject --sample=1/25 --duration=60