Observabilité

Comment RustFS expose la télémétrieCopy Anchor Link

RustFS pousse les métriques, les traces et les journaux via OTLP (OpenTelemetry Protocol). Il n’expose pas de point de terminaison Prometheus /metrics natif pour la collecte (scrape) : aucune route HTTP sur le port 9000 ou 9001 ne sert le format texte Prometheus. Pour acheminer les métriques RustFS vers Prometheus, vous devez exécuter un collecteur OpenTelemetry qui reçoit l’OTLP depuis RustFS et réexpose les données au format Prometheus :

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

Pointez RustFS vers le collecteur avec :

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

Variables d’environnement associées (toutes définies dans la configuration du serveur) :

Déploiement de référence (profil d’observabilité Docker Compose)Copy Anchor Link

Le dépôt amont rustfs/rustfs fournit une pile de référence complète dans docker-compose.yml, derrière le profil observability : otel-collector, Prometheus, Grafana, Loki (journaux), Tempo et Jaeger (traces). La configuration de son collecteur reçoit l’OTLP sur 4317 (gRPC) et 4318 (HTTP), puis réexporte les métriques pour Prometheus sur le 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 collecte ensuite le collecteur, et non 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

Référence des métriquesCopy Anchor Link

Chaque nom ci-dessous est vérifié dans le code source du serveur. La liste couvre le sous-ensemble utile à l’exploitation, exporté via OTLP ; les instruments internes et expérimentaux sont omis, et les nouvelles versions peuvent ajouter des métriques absentes de cette liste. Les jeux d’étiquettes sont ceux enregistrés au point d’émission. Le collecteur et Prometheus peuvent ajouter des étiquettes de ressource supplémentaires, telles que service_name et l’instance.

État de préparation et processusCopy Anchor Link

ScannerCopy Anchor Link

Réparation des donnéesCopy Anchor Link

Chemin d’API et d’E/SCopy Anchor Link

Contre-pressionCopy Anchor Link

CapacitéCopy Anchor Link

VerrouillageCopy Anchor Link

Nettoyage des journauxCopy Anchor Link

Alertes suggéréesCopy Anchor Link

Collecte des journauxCopy Anchor Link

La destination des journaux est contrôlée par RUSTFS_OBS_LOG_DIRECTORY :

• Non définie — les journaux vont sur stdout. Dans les conteneurs, utilisez votre pilote de journalisation ; sur les hôtes systemd, stdout/stderr est capturé par journald, de sorte que journalctl -u rustfs -f fonctionne sans configuration supplémentaire.
• Un répertoire local (par exemple /var/log/rustfs/) — RustFS y écrit des fichiers journaux en rotation. La rotation se règle avec RUSTFS_OBS_LOG_FILENAME, RUSTFS_OBS_LOG_ROTATION_SIZE_MB, RUSTFS_OBS_LOG_ROTATION_TIME et RUSTFS_OBS_LOG_KEEP_FILES.
• Une URL (contient ://) — les journaux sont expédiés vers un point de terminaison distant.

Lorsque RUSTFS_OBS_ENDPOINT est défini et que l’export des journaux est activé, les journaux sont en outre exportés via OTLP ; la pile de référence les achemine vers Loki pour les interroger depuis Grafana.

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