aikoven/foundationdb-exporter

FoundationDB Exporter Docker镜像文档

1. 镜像概述和主要用途

FoundationDB Exporter是一个Prometheus导出器（Exporter），专为FoundationDB数据库设计。其核心功能是将FoundationDB的https://apple.github.io/foundationdb/mr-status.html%EF%BC%88%E6%9C%BA%E5%99%A8%E5%8F%AF%E8%AF%BB%E7%8A%B6%E6%80%81%E6%95%B0%E6%8D%AE%EF%BC%89%E8%BD%AC%E6%8D%A2%E4%B8%BAPrometheus%E5%8F%AF%E9%87%87%E9%9B%86%E7%9A%84%E6%8C%87%E6%A0%87%E6%A0%BC%E5%BC%8F%EF%BC%8C%E5%AE%9E%E7%8E%B0%E5%AF%B9FoundationDB%E9%9B%86%E7%BE%A4%E7%9A%84%E7%9B%91%E6%8E%A7%E6%95%B0%E6%8D%AE%E6%A0%87%E5%87%86%E5%8C%96%E9%87%87%E9%9B%86%E3%80%82

2. 核心功能和特性

• 基于Machine-Readable Status：直接解析FoundationDB提供的机器可读状态数据，确保监控指标与数据库内部状态一致。
• Prometheus指标暴露：通过HTTP端点:9444/metrics提供标准化Prometheus指标，支持Prometheus直接拉取。
• Grafana集成支持：配套提供预定义的Grafana仪表盘配置，可快速实现监控数据可视化。

3. 使用场景和适用范围

3.1 使用场景

• FoundationDB集群健康状态监控（如节点存活、角色分布、数据均衡等）。
• FoundationDB性能指标采集（如操作延迟、吞吐量、错误率等）。
• 与Prometheus+Grafana监控体系集成，构建FoundationDB专属监控面板。

3.2 适用范围

适用于已部署FoundationDB集群，且采用Prometheus作为指标采集工具、Grafana作为可视化平台的监控场景。

4. 详细使用方法和配置说明

4.1 前提条件

• 已安装Docker环境。
• FoundationDB集群正常运行，且Exporter可访问集群的Machine-Readable Status接口。
• Prometheus服务已部署，用于采集Exporter暴露的指标。

4.2 镜像信息

• 镜像地址：aikoven/foundationdb-exporter（Docker Hub）

4.3 运行方式

4.3.1 基础运行（docker run）

通过docker run命令启动容器，需映射Exporter的指标端口（默认9444）：

bash
docker run -d \
  --name foundationdb-exporter \
  -p 9444:9444 \
  aikoven/foundationdb-exporter

• -p 9444:9444：将容器内9444端口映射到主机，供Prometheus采集指标。

4.3.2 Docker Compose配置

在docker-compose.yml中定义服务：

yaml
version: '3'
services:
  foundationdb-exporter:
    image: aikoven/foundationdb-exporter
    container_name: foundationdb-exporter
    ports:
      - "9444:9444"
    restart: unless-stopped

启动命令：docker-compose up -d

4.4 指标端点验证

容器启动后，通过访问http://<主机IP>:9444/metrics验证指标是否正常暴露。若返回Prometheus格式的指标数据（如foundationdb_cluster_health、foundationdb_process_count等），则说明部署成功。

5. 支持的指标

Exporter支持的具体指标定义在源码中，可通过以下链接查看完整指标列表：
https://github.com/aikoven/foundationdb-exporter/blob/master/exporter/src/metrics.ts

6. Grafana Dashboard集成

6.1 仪表盘配置文件

项目仓库中提供预定义的Grafana仪表盘配置：https://github.com/aikoven/foundationdb-exporter/blob/master/grafana/foundationdb.json%E3%80%82

6.2 导入方法

1. 登录Grafana控制台，进入Dashboards > Import。
2. 上传foundationdb.json文件或直接输入该文件的GitHub RAW URL。
3. 选择数据源（关联Prometheus实例），完成导入。

6.3 仪表盘预览

仪表盘包含集群健康状态、节点分布、性能趋势等监控视图，预览图见：
!https://github.com/aikoven/foundationdb-exporter/raw/master/docs/grafana.png

7. 注意事项

• 若FoundationDB集群部署在容器网络或私有网络中，需确保Exporter容器与FoundationDB集群网络互通。
• 指标采集频率需与Prometheus的scrape配置匹配，建议设置为10-30秒/次。
• 如需自定义FoundationDB连接参数（如集群文件路径、认证信息等），请参考官方源码或文档获取环境变量配置方式。