RustFS

RustFS reports metrics, traces, and logs to DataKit through OpenTelemetry OTLP.

Configuration¶

Prerequisites¶

• DataKit is installed, and RustFS can access DataKit's HTTP API port 9529.

Enable DataKit OpenTelemetry ingestion¶

cd /usr/local/datakit/conf.d
sudo cp samples/opentelemetry.conf.sample opentelemetry.conf
sudo vim opentelemetry.conf

[[inputs.opentelemetry]]
  split_service_name = false

  [inputs.opentelemetry.http]

Restart DataKit:

sudo datakit service -R

Start RustFS¶

The following example runs RustFS and DataKit on the same host:

docker pull rustfs/rustfs:latest

docker run -d \
  --name rustfs \
  --restart unless-stopped \
  --network host \
  -v rustfs-data:/data \
  -e RUSTFS_VOLUMES=/data \
  -e RUSTFS_ADDRESS=0.0.0.0:9000 \
  -e RUSTFS_CONSOLE_ADDRESS=0.0.0.0:9001 \
  -e RUSTFS_CONSOLE_ENABLE=true \
  -e RUSTFS_ACCESS_KEY='<YOUR_ACCESS_KEY>' \
  -e RUSTFS_SECRET_KEY='<YOUR_SECRET_KEY>' \
  -e RUSTFS_OBS_ENDPOINT=http://127.0.0.1:9529/otel \
  -e RUSTFS_OBS_SERVICE_NAME=rustfs-local-validation \
  -e RUSTFS_OBS_ENVIRONMENT=local \
  -e RUSTFS_OBS_SAMPLE_RATIO=1.0 \
  -e RUSTFS_OBS_METER_INTERVAL=10 \
  -e RUSTFS_OBS_LOGGER_LEVEL=info \
  -e RUSTFS_OBS_LOG_STDOUT_ENABLED=true \
  rustfs/rustfs:latest

When they run on different hosts, set RUSTFS_OBS_ENDPOINT to http://<DATAKIT_HOST>:9529/otel, which must be reachable from RustFS.

Verification¶

1. Perform S3 upload and download operations. In Guance, query otel_service, filter by service_name=rustfs-local-validation, and verify that rustfs_process_uptime_seconds and rustfs_s3_put_object_total continue to be reported.
2. Query traces with service=rustfs-local-validation and logs with source=rustfs-local-validation to verify data reporting.

Metrics¶

RustFS metrics are written to otel_service through OTLP. The following table lists the metrics used by this integration.