MongoDB Exporter 项目教程

1. 项目目录结构及介绍

MongoDB Exporter 项目的目录结构如下：

mongodb_exporter/
├── 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 二进制文件)
├── scripts/
├── docker/
├── docs/
├── exporter/
├── internal/
├── tools/
├── .gitignore
├── .golangci-required.yml
├── .golangci.yml
├── .goreleaser.yml
├── CHANGELOG
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── REFERENCE.md
├── docker-compose.yml
├── go.mod
├── go.sum
├── main.go
└── main_test.go

目录结构介绍

• build/: 包含构建生成的二进制文件和配置文件。
• scripts/: 包含项目使用的脚本文件。
• docker/: 包含 Docker 相关的文件。
• docs/: 包含项目的文档文件。
• exporter/: 包含 Exporter 的核心代码。
• internal/: 包含项目的内部代码。
• tools/: 包含项目使用的工具代码。
• .gitignore: Git 忽略文件配置。
• .golangci-required.yml: GolangCI 配置文件。
• .golangci.yml: GolangCI 配置文件。
• .goreleaser.yml: Goreleaser 配置文件。
• CHANGELOG: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明。
• REFERENCE.md: 项目参考文档。
• docker-compose.yml: Docker Compose 配置文件。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块依赖校验文件。
• main.go: 项目主入口文件。
• main_test.go: 项目测试文件。

2. 项目启动文件介绍

main.go

main.go 是 MongoDB Exporter 项目的主入口文件。它负责初始化 Exporter 并启动 HTTP 服务器以暴露 Prometheus 指标。

package main

import (
    "github.com/percona/mongodb_exporter/exporter"
    "github.com/prometheus/client_golang/prometheus/promhttp"
    "net/http"
)

func main() {
    // 初始化 Exporter
    e := exporter.NewExporter()

    // 注册 Exporter
    prometheus.MustRegister(e)

    // 启动 HTTP 服务器
    http.Handle("/metrics", promhttp.Handler())
    http.ListenAndServe(":9216", nil)
}

main_test.go

main_test.go 是项目的测试文件，包含对 main.go 中代码的单元测试。

3. 项目配置文件介绍

config.yaml

config.yaml 是 MongoDB Exporter 的配置文件，用于配置 Exporter 的行为。以下是一个示例配置文件：

mongodb:
  uri: "mongodb://127.0.0.1:27017"
  user: "admin"
  password: "password"
  collstats-colls: "db1.collection1,db2.collection2"
  compatible-mode: true
  collector:
    profile: true
    shards: true

配置项介绍

• mongodb.uri: MongoDB 连接字符串。
• mongodb.user: MongoDB 用户名。
• mongodb.password: MongoDB 密码。
• mongodb.collstats-colls: 需要监控的数据库和集合列表。
• mongodb.compatible-mode: 是否启用兼容模式。
• mongodb.collector.profile: 是否启用性能分析收集器。
• mongodb.collector.shards: 是否启用分片收集器。

通过这些配置项，可以灵活地配置 MongoDB Exporter 以适应不同的监控需求。