clevercloud/fdbexporter repository overview

⁠FoundationDB Metrics Exporter

A tool which will poll status of your FoundationDB cluster and expose human-readable metrics for Prometheus. When it is useful, metrics are tagged with appropriate data to be easily retriveable.

Metrics this exporter exposes are available in METRICS.md⁠.

Not all metrics from status are yet available, but the ones we use are available. If you need more metrics, feel free to contribute!

⁠Getting started

⁠Other methods

You can run directly the exporter through a binary, see README.md⁠

⁠Docker

We expect that you have a FoundationDB running and accessible from the container. You can start with a sample cluster⁠ to try the exporter.

# Pull exporter version 1.0.0 for FoundtionDB version 7.3.63
docker pull clevercloud/fdbexporter:latest-7.3.63
# Environment variables:
#   FDB_COORDINATOR: DNS name of the coordinator node
#   FDB_COORDINATOR_PORT: Port of the coordinator node process
#   FDB_NETWORKING_MODE: Either container or host, describe docker networking
docker run \
  -e FDB_NETWORKING_MODE=container \
  -e FDB_COORDINATOR=coordinator \
  -e FDB_COORDINATOR_PORT=4500 \
  clevercloud/fdbexporter:latest-7.3.63

⁠Image tagging

The exporter images are tagged based on both the exporter version and on FoundationDB versions. Each new version of the exporter will create a container tag as follow: ${exporter_version}-${foundationdb_version}. Our CI will create tags for latest patch version for FoundationDB 7.3 and 7.1. We do not create tag for version 7.2 as it shouldn't be used in production.