ng-monitoring 使用指南

ng-monitoring 使用指南

ng-monitoring项目地址:https://gitcode.com/gh_mirrors/ng/ng-monitoring

---

项目目录结构及介绍

ng-monitoring 是一个用于监控 TiDB 生态系统的下一代监控服务器。其内部结构设计精良，便于管理和扩展。以下是该仓库的基本目录布局及其简要说明：

.
├── bin                     # 包含可执行文件 ng-monitoring-server
├── config                  # 配置文件目录，通常存放 ngmonitoring.toml 示例或自定义配置
│   └── config.toml.example # 配置模板文件
├── data                    # 默认的数据存储路径，用于保存监控数据
├── docs                    # 项目相关文档
├── internal                # 内部实现代码，包括服务、数据库交互等逻辑
├── scripts                 # 可能包含部署、管理脚本
├── tests                   # 测试文件夹，单元测试和集成测试等
├── utils                   # 辅助工具和函数库
├── .gitignore              # Git 忽略文件列表
├── golangci.yml            # Golang CI 配置文件
├── LICENSE                 # 开源许可证文件，遵循 Apache-2.0 协议
├── Makefile                # 构建和管理项目的Makefile
├── OWNERS                  # 维护者列表，指定代码审查负责人
├── README.md               # 项目的主要读我文件，简介和快速入门
├── go.mod                  # Go modules 文件，定义依赖关系
└── go.sum                  # Go依赖包的校验文件

项目的启动文件介绍

ng-monitoring 的主要启动文件位于 bin/ng-monitoring-server。通过这个二进制文件，你可以启动 ng-monitoring 服务。启动命令通常涉及指定配置文件路径，示例如下：

bin/ng-monitoring-server --config /path/to/your/config.toml

其中，--config 参数指定了 ng-monitoring 读取的配置文件位置。

项目的配置文件介绍

配置文件是 ng-monitoring 个性化设置的核心，典型的配置文件命名如 config.toml。关键配置项包括：

# NG Monitoring Server Configuration
[server]
  address = "0.0.0.0:12020"  # 监听地址
  advertise-address = "..."  # （可选）广告的地址，若与监听地址不同

[log]
  path = "log"             # 日志文件路径
  level = "INFO"           # 日志级别
  
[pd]
  endpoints = ["0.0.0.0:2379"]  # PD实例地址，多个以逗号分隔

[storage]
  path = "data"            # 存储监控数据的路径，可自定义
  # 其它可能的配置项，如数据保留周期(retention-period)

配置文件允许你定制 ng-monitoring 的运行时行为，比如网络端口、日志级别、PD 地址以及数据存储细节等。确保根据实际环境调整这些配置参数，以达到最佳的监控效果和系统资源利用。

ng-monitoring项目地址:https://gitcode.com/gh_mirrors/ng/ng-monitoring