Telemetry Settings

This page covers settings that manage OpenTelemetry-formatted trace information for the MinIO AIStor process. Trace capture supports ongoing troubleshooting and diagnostics.

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.

You can establish or modify settings by defining:

  • an environment variable on the host system prior to starting or restarting the AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
  • a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO AIStor uses the environment variable value.

Each configuration setting controls fundamental MinIO AIStor behavior and functionality. Test configuration changes in a lower environment, such as DEV or QA, before applying to production.

Enable

Enable or disable telemetry collection on the specified target.

Valid values are on or off.

The default value is off.

Endpoint

Required

IP address or FQDN and port of the OTLP-compatible collector that processes the data.

export MINIO_TELEMETRY_TARGET_ENDPOINT="http://otlp.example.net:4318"

TLS

Optional

Whether TLS is configured on the target endpoint.

Valid values are on or off.

The default value is off.

TLS skip verify

Optional

Skip TLS certificate verification for the target endpoint.

Valid values are on or off.

The default value is off.

TLS client certificate

Optional

Path to the client certificate for mTLS authentication with the target server.

If not provided, MinIO AIStor encrypts the telemetry file with the MinIO AIStor public certificate.

TLS client key

Optional

Path to the client private key for mTLS authentication with the target server.

If not specified, defaults to support_private.pem.

Sample rate

A fraction, percentage, or float between 0 and 1 of the portion of calls to trace. Higher sample rates provide more complete data but have greater impact on system performance.

If not specified, defaults to 1.0 (all calls traced).

Trace type

Optional

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

Capitalization is ignored when specifying trace types.

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

Function name filter

Optional

Return traces only for calls that match the specified function name substring. Use this to narrow trace output to specific code paths.