mc support telemetry proxy
The mc support telemetry proxy command streams API events from all nodes on the MinIO AIStor deployment to the specified remote OpenTelemetry Protocol (OTLP)-compatible collector.
Use the --sample flag to modify the number of calls traced and adjust the impact on performance.
By default, the command runs in the current shell session until manually stopped.
Syntax
The following command streams the S3 API calls on the alias myaistor to an OTLP-compatible tracing service running on localhost.
mc support telemetry proxy myaistor http://127.0.0.1:4318The command has the following syntax:
mc [GLOBALFLAGS] support telemetry proxy \
ALIAS \
SERVER \
[--duration "integer"] \
[--type "string"] \
[--sample "string"] \
[--incoming] \
[--func "string"]- 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 full path to the alias, prefix, or object where the command should run. The path must include at least an ALIAS.
SERVER
Required
IP address or FQDN and port of the OTLP-compatible collector that processes the data.
For example, http://otlp.example.net:4318 or http://127.0.0.1:4318.
--duration
Optional
Number of seconds after which to stop the proxy.
If not specified, it defaults to 0 and runs until stopped.
--func
Optional
Return traces only on calls that match the specified substring.
For example, --func=PutObject, to return traces only on PutObject calls.
--incoming
Optional
Trace incoming requests that include OpenTelemetry headers.
--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 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:
| Type | Description |
|---|---|
Admin | Admin calls |
BatchExpire | Batch expiration operation calls |
BatchKeyRotation | Batch key rotation operation calls |
BatchReplication | Batch replication operation calls |
Bootstrap | Events during MinIO AIStor cluster bootstrap |
Decommission | Decommission operation calls |
Formatting | Formatting events |
FTP | FTP server calls |
Healing | Healing operation calls |
IAM | Identity and access management calls |
ILM | Lifecycle management calls |
Internal | Calls to the .minio.sys/ folder |
KMS | Calls that interact with the configured KMS |
Object | Calls to the object layer |
OS | Golang OS package calls |
Replication | Replication events as they are picked up by workers |
ReplicationResync | Resync operation calls |
Rebalance | Rebalance operation calls |
S3 | S3 API calls |
Scanner | Scan operation calls |
Storage | Calls to the storage layer |
Capitalization is ignored when specifying trace types.
Global flags
This command supports any of the global flags.
Examples
Trace all calls and forward to localhost
The following command captures traces from the myaistor cluster and streams them to an OTLP-compatible collector running on localhost:
mc support telemetry proxy myaistor http://127.0.0.1:4318Trace 1 out of 10 calls and stream to an external OTLP server
The following command captures traces for 1 of every 10 calls on the myaistor server and streams them to an external OTLP collector:
mc support telemetry proxy --sample=1/10 myaistor http://otlp.example.net:4318Trace PutObject calls and forward to localhost
The following command captures one of every ten PutObject traces on the myaistor server and streams them an OTLP-compatible collector running on localhost:
mc support telemetry proxy --func=PutObject --sample=0.1 myaistor http://127.0.0.1:4318