Skip to content

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

CMDB Mini Agent

cmdb_mini_agent 是一个轻量级、跨平台的主机信息采集 Agent,用于配合 VEOPS CMDB 使用。

Agent 部署在目标主机上,负责采集主机唯一标识、网络、操作系统和硬件信息, 并通过 VEOPS CMDB API 创建或更新对应的 CI 数据。程序启动时会立即上报一次, 之后默认每 900 秒刷新一次。

本项目是面向 VEOPS CMDB 的独立 Agent 采集器。使用前需先部署 VEOPS CMDB, 并在 CMDB 中建立与本项目上报字段相匹配的 CI 模型。

功能特性

  • 支持 Linux、Windows 和 macOS。
  • 获取并规范化主机 product_uuid,不同平台均提供兜底采集方式。
  • 获取主机出站使用的本机 IP。
  • 自动识别虚拟机或物理机,也可通过配置或命令行指定主机类型。
  • 采集 CPU、内存、磁盘、主机名、系统架构等基础信息。
  • 在支持的平台上采集 BIOS 日期、系统供应商和系统版本。
  • 启动时自动创建或校验唯一 CI,并立即更新主机数据。
  • 默认每 900 秒定时刷新 CMDB 中的主机信息。
  • 支持 JSON 或文本日志。
  • 支持 macOS、Linux 和 Windows 交叉编译。

采集与上报字段

CMDB 属性 说明
cmdb_auto_product_uuid 主机唯一标识,也是 Agent 使用的唯一键
cmdb_auto_ipaddr 主机出站使用的本机 IP
cmdb_auto_env 主机所属环境,例如 offline、prod
cmdb_auto_machine_type 主机类型,例如 virtual、physical、hwy、aly
cmdb_auto_os_type 操作系统类型
cmdb_auto_cpu CPU 核数
cmdb_auto_memory 内存总量
cmdb_auto_disk 磁盘总容量
cmdb_auto_nodename 主机名
cmdb_auto_architecture 系统架构
cmdb_auto_bios_date BIOS 日期
cmdb_auto_system_vendor 系统或硬件供应商
cmdb_auto_system_release 系统发行版或内核版本
cmdb_auto_update_time 最近更新时间

CMDB 中的 CI Type 必须包含上述属性。实际使用的 CI Type 由 configs/config.yaml 中的 cmdb.ciType 指定。

工作流程

  1. 加载 configs/config.yaml。
  2. 解析命令行参数,并覆盖对应配置。
  3. 初始化日志和 CMDB API 客户端。
  4. 检查 CMDB 服务连通性。
  5. 获取主机 UUID,创建或校验唯一 CI。
  6. 采集主机信息并更新 CI。
  7. 启动定时任务,每 900 秒重复创建校验和数据更新。
  8. 接收到 SIGINT 或 SIGTERM 后优雅退出。

如果初始化阶段无法连接 CMDB,Agent 会退出,避免在连接异常时静默运行。

环境要求

  • 已部署可访问的 VEOPS CMDB。
  • 已在 CMDB 中创建主机 CI 模型及对应属性。
  • 已获取具有 CI 创建和更新权限的 CMDB API Key 与 Secret。
  • 源码构建需要 Go 1.24 或兼容版本。
  • 运行账户需要读取配置文件并写入日志目录的权限。

快速开始

1. 获取代码

git clone https://github.com/bearqy/cmdb_mini_agent.git
cd cmdb_mini_agent

2. 配置 Agent

编辑 configs/config.yaml:

global:
  # 可留空并使用自动识别,也可设置为 virtual、physical、hwy、aly 等
  machineType: "virtual"
  env: "offline"

log:
  level: info
  format: json
  runtimeLogFile:

cmdb:
  address: "https://cmdb.example.com"
  Key: "<YOUR_API_KEY>"
  Secret: "<YOUR_API_SECRET>"
  ciType: "your_machine_ci_type"

主要配置项:

  • global.machineType:主机类型;可被 --machine 或 -m 覆盖。
  • global.env:环境标识;可被 --env 或 -e 覆盖。
  • log.level:日志级别,支持 debug、info。
  • log.format:日志格式,支持 json、text。
  • log.runtimeLogFile:运行日志路径;留空时使用默认路径。
  • cmdb.address:VEOPS CMDB 服务地址,需包含协议。
  • cmdb.Key、cmdb.Secret:CMDB API 认证信息。
  • cmdb.ciType:接收 Agent 上报数据的 CI Type。

配置优先级为:代码默认值 < 配置文件 < 命令行参数。

3. 构建

在当前平台直接构建:

go build -o cmdb_mini_agent .

项目也提供了交叉编译脚本:

# macOS arm64
bash 003---代码打包为二进制包.sh mac

# Linux amd64
bash 003---代码打包为二进制包.sh linux

# Windows amd64
bash "005---代码打包为exe包(Windows).sh"

对应输出文件:

  • cmdb_mini_agent_darwin_arm64
  • cmdb_mini_agent_linux_amd64
  • cmdb_mini_agent_windows_amd64.exe

4. 运行

可执行文件需要能够访问同级目录下的 configs/config.yaml:

cmdb_mini_agent
configs/
  config.yaml
logs/
  log_runtime.log

启动:

./cmdb_mini_agent

使用命令行参数覆盖环境和主机类型:

./cmdb_mini_agent --machine=physical --env=prod

短参数写法:

./cmdb_mini_agent -m aly -e prod

查看默认运行日志:

tail -f logs/log_runtime.log

Linux systemd 部署示例

[Unit]
Description=CMDB Mini Agent
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
WorkingDirectory=/opt/cmdb_mini_agent
ExecStart=/opt/cmdb_mini_agent/cmdb_mini_agent --env=prod
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

保存为 /etc/systemd/system/cmdb-mini-agent.service 后执行:

sudo systemctl daemon-reload
sudo systemctl enable --now cmdb-mini-agent
sudo systemctl status cmdb-mini-agent

项目结构

.
├── main.go                         # 程序入口
├── apps/machine.go                 # 主机采集和 CI 创建/更新逻辑
├── model/CMDB/                     # CMDB API 数据模型与请求封装
├── pkg/utils/CMDBClient/           # CMDB 签名、URL 和连接检查
├── pkg/utils/HostInfo/             # 跨平台主机信息采集
├── pkg/utils/initialize/           # 配置、参数、日志、CMDB 和定时任务初始化
├── pkg/utils/crontab/              # 周期任务
├── pkg/utils/loggers/              # 日志封装
├── configs/config.yaml             # Agent 配置
├── docs/                           # 详细文档
├── 003---代码打包为二进制包.sh       # macOS/Linux 构建脚本
└── 005---代码打包为exe包(Windows).sh # Windows 构建脚本

详细文档

开发与验证

运行全部测试:

go test ./...

格式化 Go 代码:

go fmt ./...

安全注意事项

  • 不要将真实的 CMDB 地址、Key 或 Secret 提交到 Git 仓库。
  • 示例配置中的认证信息均为占位符,部署时请在受控环境中填写。
  • 建议限制 configs/config.yaml 的文件权限,并仅授予 Agent 运行账户读取权限。
  • API Key 应遵循最小权限原则,只授予 Agent 所需的 CI 查询、创建和更新权限。
  • 如果密钥曾被提交到代码历史中,应立即轮换密钥并清理 Git 历史。

License

本项目暂未声明开源许可证。使用、分发或二次开发前,请先确认相应授权。

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages