orion-visor-agent 实例监控探针

简介

orion-visor-agent 是一个由 Go 语言 开发的轻量级系统监控探针, 能够实时收集并上报系统指标数据到 orion-visor。它支持多种操作系统, 包括 Linux、Windows 和 Darwin, 并同时支持 amd64 arm64 系统架构。该项目为 闭源项目。

最新版本

通信方式

• 指标与心跳数据通过 HTTP 主动上报 给 orion-visor。(1min)

项目文档

• 文档地址
• 更新日志
• 常见问题

发布地址

可从以下地址下载发布包。如果 GitHub 下载失败, 可以尝试使用 Gitee 镜像：

• GitHub 最新发布版本
• GitHub 主分支直链
• Gitee 主分支直链

配置说明

手动启动时 使用前必须要保证如下配置的正确性

# agent 设置
agent:
  # 客户端 key (监控主机对应的 agentKey, 主机监控 > 操作 > 复制 Key)
  key: $${AGENT_KEY}

# 服务端设置
server:
  # 服务端地址 (http://server:9200/orion-visor/api) (docker 中的 API_HOST/API_URL / application-prod.yaml 中的 orion.api.host/url)
  url: $${SERVER_URL}
  # 服务端 token (docker 中的 API_EXPOSE_TOKEN / application-prod.yaml 中的 orion.api.expose.token)
  token: $${SERVER_TOKEN}

# 日志设置
zap:
  # 日志文件路径 ${home} 为家目录, ${context} 为上下文目录
  path: ${context}/logs

全部命令

instance_agent [command] [flags] [上下文目录]

# 帮助文档
./instance_agent help

# 查看版本
./instance_agent version

# 启动探针
./instance_agent start .

# 停止探针
./instance_agent stop .
  -k | --kill   发送 kill 信号
  -f | --force  强制停止此 pid

目录结构

/root/orion/orion-visor/instance-agent/
├── config.yaml           # 配置文件
├── instance_agent        # 探针可执行文件 (Linux / macOS) 
├── instance_agent.exe    # 探针可执行文件 (Windows)
├── start.sh              # 启动脚本 (Linux / macOS)
├── start.cmd             # 启动脚本 (Windows)
├── .pid                  # 当前运行进程的 PID (启动时生成)
├── logs/                 # 日志目录

手动启动 (Linux/Darwin)

如果为 root 用户执行 start.sh, 系统将自动注册 systemctl 服务并设置自启 (orion-visor-instance-agent.service)

# 1. 创建文件夹
mkdir -p ${home}/orion/orion-visor/instance-agent
cd ${home}/orion/orion-visor/instance-agent
# 2. 解压缩发布包
tar -zxvf instance-agent-release.tar.gz
# 3. 修改配置文件中 $$ 开头的变量
vim config.yaml 
# 4. 重命名对应的启动文件 
mv instance_agent_<os>_<arch> instance_agent
# 5. 提权
chmod +x instance_agent
chmod +x ./start.sh
# 6. 启动探针
./start.sh
# 7. 查看日志
tail -f logs/app.log

手动启动 (Windows)

windows 因为平台限制, 不支持自动安装。手动安装流程同上

Docker 启动

同时支持 linux/amd64 和 linux/arm64 架构

支持以下源

• lijiahangmax/*
• ghcr.io/lijiahangmax/*
• registry.cn-hangzhou.aliyuncs.com/orionsec/*

# 创建挂载目录
mkdir -p /data/orion-visor-space/orion-visor-agent/volumes
# 拉取最新版本
docker pull registry.cn-hangzhou.aliyuncs.com/orionsec/orion-visor-agent:latest
# 启动
docker run -d \
  --name orion-visor-agent-1 \
  --restart=on-failure:15 \
  -e SERVER_URL="http://127.0.0.1:9200/orion-visor/api" \
  -e SERVER_TOKEN="pmqeHOyZaumHm0Wt" \
  -e AGENT_KEY="agentKey" \
  -v /data/orion-visor-space/orion-visor-agent/volumes/logs:/instance-agent/logs \
  registry.cn-hangzhou.aliyuncs.com/orionsec/orion-visor-agent:latest

docker compose 启动

在启动前需要修改 环境变量

# 修改环境变量
vim docker-compose.yaml
# 创建挂载目录
mkdir -p /data/orion-visor-space/orion-visor-agent/volumes
# 拉取最新版本
docker compose pull
# 启动
docker compose up -d