Observability

Wie RustFS Telemetrie bereitstelltCopy Anchor Link

RustFS sendet Metriken, Traces und Protokolle über OTLP (OpenTelemetry Protocol). Es stellt keinen nativen Prometheus-Endpunkt /metrics zum Scrapen bereit. Auf Port 9000 oder 9001 gibt es keine HTTP-Route, die das Prometheus-Textformat ausliefert. Um RustFS-Metriken nach Prometheus zu bringen, müssen Sie einen OpenTelemetry Collector betreiben, der OTLP von RustFS empfängt und die Daten im Prometheus-Format erneut bereitstellt:

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

Richten Sie RustFS auf den Collector aus:

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

Zugehörige Umgebungsvariablen (alle in der Serverkonfiguration definiert):

Referenzbereitstellung (Observability-Profil von Docker Compose)Copy Anchor Link

Das Upstream-Repository rustfs/rustfs liefert in docker-compose.yml hinter dem Profil observability einen vollständigen Referenzstapel: otel-collector, Prometheus, Grafana, Loki (Protokolle), Tempo und Jaeger (Traces). Die Collector-Konfiguration empfängt OTLP auf 4317 (gRPC) und 4318 (HTTP) und exportiert Metriken für Prometheus erneut auf Port 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 scrapt danach den Collector, nicht RustFS:

# 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

MetrikreferenzCopy Anchor Link

Jeder Name unten ist gegen den Serverquellcode geprüft. Die Liste umfasst die betrieblich relevante Teilmenge, die über OTLP exportiert wird. Interne und experimentelle Instrumente sind ausgelassen, und neue Versionen können Metriken hinzufügen, die hier nicht stehen. Die Label-Sätze sind die am Emissionsort aufgezeichneten. Collector und Prometheus können weitere Ressourcenlabels anhängen, etwa service_name und die Instanz.

Bereitschaft und ProzessCopy Anchor Link

ScannerCopy Anchor Link

DatenwiederherstellungCopy Anchor Link

API- und E/A-PfadCopy Anchor Link

GegendruckCopy Anchor Link

KapazitätCopy Anchor Link

SperrenCopy Anchor Link

ProtokollbereinigungCopy Anchor Link

Empfohlene AlarmeCopy Anchor Link

ProtokollerfassungCopy Anchor Link

Wohin Protokolle gehen, steuert RUSTFS_OBS_LOG_DIRECTORY:

• Nicht gesetzt: Protokolle gehen nach stdout. Verwenden Sie in Containern Ihren Log-Treiber. Auf systemd-Hosts erfasst journald stdout und stderr, deshalb funktioniert journalctl -u rustfs -f ohne weitere Konfiguration.
• Ein lokales Verzeichnis (z. B. /var/log/rustfs/): RustFS schreibt dort rotierende Protokolldateien. Die Rotation stellen Sie mit RUSTFS_OBS_LOG_FILENAME, RUSTFS_OBS_LOG_ROTATION_SIZE_MB, RUSTFS_OBS_LOG_ROTATION_TIME und RUSTFS_OBS_LOG_KEEP_FILES ein.
• Eine URL (enthält ://): Protokolle werden an einen entfernten Endpunkt geliefert.

Wenn RUSTFS_OBS_ENDPOINT gesetzt ist und der Protokollexport aktiviert ist, werden Protokolle zusätzlich über OTLP exportiert. Der Referenzstapel leitet sie zur Abfrage aus Grafana nach 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