percona/mongodb_exporter

MongoDB Exporter

镜像概述和主要用途

MongoDB Exporter是一个Prometheus导出器，用于收集MongoDB数据库的监控指标，包括分片、复制和存储引擎等方面的性能数据。该实现能够处理MongoDB监控命令公开的所有指标，通过循环遍历诊断命令中公开的所有字段并尝试从中获取数据。

核心功能和特性

• 全面的指标收集：支持MongoDB多种诊断命令提供的所有指标
• 灵活的指标来源：能够从多种MongoDB诊断命令获取数据
• 兼容性模式：支持旧版指标格式，简化迁移过程
• 自动发现：可自动发现指定数据库中的集合
• 自定义监控对象：允许指定要监控的集合和索引
• 集群感知：提供集群角色标签，便于区分不同节点类型

指标来源

目前实现了以下指标来源：

• $collStats
• $indexStats
• getDiagnosticData
• replSetGetStatus
• serverStatus

与旧版的兼容性

使用场景和适用范围

• MongoDB数据库性能监控
• 与Prometheus和Grafana集成构建监控系统
• 支持独立MongoDB实例、副本集和分片集群
• 需要详细了解数据库、集合和索引性能的场景

使用方法和配置说明

构建方法

构建过程使用dockerized版本的goreleaser，无需安装Go环境：

bash
make release

生成的二进制文件将位于build目录下：

├── build
│ ├── config.yaml
│ ├── mongodb_exporter_7c73946_checksums.txt
│ ├── mongodb_exporter-7c73946.darwin-amd64.tar.gz
│ ├── mongodb_exporter-7c73946.linux-amd64.tar.gz
│ ├── mongodb_exporter_darwin_amd64
│ │ └── mongodb_exporter <--- MacOS二进制文件
│ └── mongodb_exporter_linux_amd64
│     └── mongodb_exporter <--- Linux二进制文件

Docker部署

Docker镜像可从Docker Hub获取：https://hub.docker.com/repository/docker/percona/mongodb_exporter

Docker Run示例

bash
docker run -d -p 9216:9216 percona/mongodb_exporter \
  --mongodb.uri=mongodb://user:pass@mongodb-host:27017/admin?ssl=true \
  --compatible-mode

Docker Compose示例

yaml
version: '3'
services:
  mongodb_exporter:
    image: percona/mongodb_exporter
    ports:
      - "9216:9216"
    command:
      - --mongodb.uri=mongodb://user:pass@mongodb:27017/admin?ssl=true
      - --compatible-mode
      - --mongodb.collstats-colls=testdb.testcol
    depends_on:
      - mongodb
  mongodb:
    image: mongo
    ports:
      - "27017:27017"
    environment:
      - MONGO_INITDB_ROOT_USERNAME=user
      - MONGO_INITDB_ROOT_PASSWORD=pass

权限配置

连接用户需要有足够的权限来查询所需的统计信息：

javascript
{
  "role": "clusterMonitor",
  "db": "admin"
},
{
  "role": "read",
  "db": "local"
}

有关MongoDB角色的更多信息，请参阅官方文档。

配置参数详解

环境变量

命令行参数

使用示例

基本运行

bash
mongodb_exporter --mongodb.uri=mongodb://127.0.0.1:17001

启用集合统计指标收集

bash
mongodb_exporter --mongodb.uri=mongodb://127.0.0.1:17001 --mongodb.collstats-colls=db1.c1,db2.c2

启用兼容性模式

启用兼容性模式后，导出器将同时以新的命名和标签模式以及版本1兼容的方式公开所有新指标：

bash
mongodb_exporter --mongodb.uri=mongodb://127.0.0.1:17001 --compatible-mode

例如，新格式指标：

# HELP mongodb_ss_wt_log_log_bytes_written serverStatus.wiredTiger.log.
# TYPE mongodb_ss_wt_log_log_bytes_written untyped
mongodb_ss_wt_log_log_bytes_written 2.6208e+06

将同时以旧格式公开：

HELP mongodb_mongod_wiredtiger_log_bytes_total mongodb_mongod_wiredtiger_log_bytes_total
# TYPE mongodb_mongod_wiredtiger_log_bytes_total untyped
mongodb_mongod_wiredtiger_log_bytes_total{type="unwritten"} 2.6208e+06

集群角色标签

导出器在所有指标中设置了一些拓扑标签：

• cl_role: 集群角色，根据下表确定：

• cl_id: 集群ID
• rs_nm: 副本集名称
• rs_state: 副本集状态，是getDiagnosticData() -> replSetGetStatus.myState返回的整数。有关副本集状态值的详细信息，请查看官方文档。