オブザーバビリティ

テレメトリの公開方法Copy Anchor Link

RustFS は、メトリクス、トレース、ログを OTLP（OpenTelemetry Protocol）でプッシュします。ネイティブの Prometheus /metrics スクレイプエンドポイントは公開しません。ポート 9000 と 9001 のどちらにも、Prometheus のテキスト形式を返す HTTP ルートはありません。RustFS のメトリクスを Prometheus へ取り込むには、RustFS から OTLP を受信し、データを Prometheus 形式で再公開する OpenTelemetry Collector を実行する必要があります。

RustFS (RUSTFS_OBS_ENDPOINT) --OTLP--> OpenTelemetry Collector --> Prometheus --> Grafana
                                                              \--> Loki (logs)
                                                              \--> Tempo / Jaeger (traces)

Collector の宛先は、次のように指定します。

# OTLP over HTTP (the Collector's default HTTP receiver port is 4318; gRPC is 4317)
RUSTFS_OBS_ENDPOINT=http://otel-collector:4318

関連する環境変数（いずれもサーバー設定で定義されています）は次のとおりです。

参照デプロイ（Docker Compose の Observability プロファイル）Copy Anchor Link

アップストリームの rustfs/rustfs リポジトリは、docker-compose.yml の observability プロファイル配下に、参照用スタック一式を同梱しています。構成は otel-collector、Prometheus、Grafana、Loki（ログ）、Tempo と Jaeger（トレース）です。Collector の設定は 4317（gRPC）と 4318（HTTP）で OTLP を受信し、Prometheus 向けにポート 8889 でメトリクスを再エクスポートします。

# OpenTelemetry Collector (excerpt from the upstream reference config)
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
exporters:
  prometheus:
    endpoint: "0.0.0.0:8889"
service:
  pipelines:
    metrics:
      receivers: [otlp]
      exporters: [prometheus]

Prometheus は RustFS をスクレイプせず、Collector をスクレイプします。

# prometheus.yml (excerpt)
scrape_configs:
  - job_name: "rustfs-app-metrics"
    static_configs:
      - targets: ["otel-collector:8889"]   # RustFS application metrics
  - job_name: "otel-collector"
    static_configs:
      - targets: ["otel-collector:8888"]   # Collector self-metrics

メトリクスリファレンスCopy Anchor Link

以下の名前は、いずれもサーバーのソースコードに照らして確認済みです。一覧は、OTLP でエクスポートされる運用に関係するサブセットです。内部向けと実験的な計器は省略しており、新しいリリースではここにないメトリクスが追加されることがあります。ラベルセットは、メトリクスを出力する箇所で記録されるものです。Collector と Prometheus は、service_name や instance などのリソースラベルを追加することがあります。

準備完了とプロセスCopy Anchor Link

スキャナーCopy Anchor Link

データ修復Copy Anchor Link

API／IO パスCopy Anchor Link

バックプレッシャーCopy Anchor Link

容量Copy Anchor Link

ロックCopy Anchor Link

ログクリーナーCopy Anchor Link

推奨アラートCopy Anchor Link

ログの収集Copy Anchor Link

ログの出力先は RUSTFS_OBS_LOG_DIRECTORY で制御します。

• 未設定の場合、ログは stdout に出力されます。コンテナではログドライバーを使います。systemd のホストでは、stdout と stderr を journald が捕捉するため、追加設定なしで journalctl -u rustfs -f を使えます。
• ローカルディレクトリ（例: /var/log/rustfs/）の場合、RustFS はそこにローテーションするログファイルを書き込みます。ローテーションは RUSTFS_OBS_LOG_FILENAME、RUSTFS_OBS_LOG_ROTATION_SIZE_MB、RUSTFS_OBS_LOG_ROTATION_TIME、RUSTFS_OBS_LOG_KEEP_FILES で調整します。
• URL（:// を含む）の場合、ログはリモートのエンドポイントへ送られます。

RUSTFS_OBS_ENDPOINT が設定され、ログのエクスポートが有効なときは、ログは OTLP でも追加でエクスポートされます。参照スタックは、Grafana から照会できるよう、これらを Loki へ送ります。

RUSTFS_ADDRESS=":9000"
RUSTFS_CONSOLE_ADDRESS=":9001"
RUSTFS_CONSOLE_ENABLE=true
RUSTFS_OBS_LOGGER_LEVEL=error
RUSTFS_OBS_LOG_DIRECTORY="/var/log/rustfs/"
RUSTFS_OBS_ENDPOINT=http://otel-collector:4318