Telemetry Settings
This page documents environment variables that manage OpenTelemetry-formatted trace information. Trace capture can support ongoing troubleshooting and diagnostics with MinIO Engineering.
The information can be relayed to a specified collector, recorded to a local encrypted or unencrypted file, or replayed from a local file to a collector.
You can also run the mc support telemetry commands for some of these settings.
MINIO_TELEMETRY_TARGET_ENABLE
Enable (or disable) telemetry collection on a specified target.
MINIO_TELEMETRY_TARGET_ENDPOINT
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.
MINIO_TELEMETRY_TARGET_TLS
Whether TLS is configured on the target.
MINIO_TELEMETRY_TARGET_TLS_SKIP_VERIFY
Optional
Save telemetry to an unencrypted file.
MINIO_TELEMETRY_TARGET_TLS_CLIENT_CERT
Optional
Path to the public key/client certificate for the target server to use for encrypting the recorded telemetry file.
If not provided, and the --unencrypted flag is not used, AIStor encrypts the file with the AIStor public certificate.
MINIO_TELEMETRY_TARGET_TLS_CLIENT_KEY
Optional
Path to the private key to use to decrypt an encrypted telemetry file you want to replay. A valid key must be provided to replay encrypted files.
If not specified, defaults to support_private.pem.
MINIO_TELEMETRY_TARGET_SAMPLE_RATE
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.
If not specified, returns data for all calls (100%).
MINIO_TELEMETRY_TARGET_TYPE
Optional
Include data for only the specified type(s) of traces, comma-separated.
If not specified, defaults 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 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.
MINIO_TELEMETRY_TARGET_FUNCNAME
Optional
Return traces only on calls that match the specified substring.