跳到主要内容

Docker Compose

本文介绍使用 Docker Compose 部署运维平台。建议与 HAP/HDP 部署在同一台服务器上,以下步骤以同机部署为例,命令均在该服务器上执行。

部署准备​

  • 确保服务器有不少于 4 核 CPU、8 GB 内存和 200 GB 磁盘的可用资源。
  • 确保服务器已安装 Docker 和 Docker Compose,并且 Docker 服务正常运行。
  • 确认 48881 端口未被占用,且客户端能够访问该端口。如需映射 3100、4317 或 4318 端口,也请检查端口占用情况并控制访问范围。
  • 准备被监控中间件的账号,权限要求见数据源管理。

执行以下命令检查 Docker 服务:

docker info

检查 Docker Compose 版本。以下任一命令能输出版本信息即可;如果第一条命令不可用,请尝试第二条:

docker compose version
docker-compose --version

示例使用 /data/mingdao/mdis/ 目录保存运维平台配置和数据。

1. 准备目录和网络​

创建部署目录:

mkdir -p /data/mingdao/mdis

运维平台与 HAP/HDP 共用 Docker 网络后,可以通过容器服务名访问该网络中的中间件和数据库,无需为这些访问额外暴露端口。HAP/HDP 运行时默认使用 script_default 网络,可通过以下命令确认网络名称:

docker network ls

下方配置默认使用 script_default。如果 HAP/HDP 使用了其他网络名称,请在创建配置文件后修改为实际名称;该网络必须已存在。

2. 获取镜像​

在线环境执行以下命令拉取镜像。离线环境请下载并导入离线镜像包。

docker pull registry.cn-hangzhou.aliyuncs.com/mdpublic/ops-allinone:1.5.12

3. 创建配置文件​

创建并编辑 /data/mingdao/mdis/ops.yaml:

vim /data/mingdao/mdis/ops.yaml

将以下内容写入文件。该文件用于配置运维平台自身的服务、网络和数据目录,被监控目标在部署完成后通过数据源页面添加。

# 所有服务使用同一镜像
x-ops-image: &ops_image registry.cn-hangzhou.aliyuncs.com/mdpublic/ops-allinone:1.5.12

x-common-env: &common_env
TZ: "Asia/Shanghai"
ENV_OPS_TOKEN: "your-ops-access-token-change-me" # 登录令牌,部署时替换为高强度口令
ENV_ALERT_CRYPTO_KEY: "change-me-to-32-byte-secret" # 凭据加密密钥,部署时替换为随机密钥并妥善保存
ENV_OPS_SUB_PATH: &ops_sub_path /mdis # 统一访问子路径;使用根路径时填写 ""
ENV_PROMETHEUS_SERVER: "http://ops-prometheus:9090" # 运维平台内置 Prometheus 地址
ENV_OPS_MONGODB_URI: "mongodb://ops-mongo:27017" # 运维平台自有 MongoDB 地址
ENV_MONGODB_COLLECTION_PREFIX: "mdis_" # 运维平台 MongoDB 集合名前缀

services:
gateway:
image: *ops_image
restart: always
ports:
- "48881:48881" # 运维平台访问端口
environment:
<<: *common_env
ROLE: gateway
depends_on:
- ops-prometheus
- ops-grafana
- ops-loki
- ops-tempo
- ops-alloy
- ops-mongo

ops-prometheus:
image: *ops_image
restart: always
volumes:
- ./volume/data/mdis/prometheus/:/data/mdis/prometheus/
environment:
<<: *common_env
ROLE: prometheus

ops-grafana:
image: *ops_image
restart: always
volumes:
- ./volume/data/mdis/grafana/:/data/mdis/grafana/
environment:
<<: *common_env
ROLE: grafana
GF_SECURITY_ALLOW_EMBEDDING: "true"
GF_AUTH_ANONYMOUS_ENABLED: "true"
GF_AUTH_ANONYMOUS_ORG_ROLE: Editor
GF_SECURITY_COOKIE_SAMESITE: lax
GF_USERS_DEFAULT_THEME: light

ops-loki:
image: *ops_image
restart: always
# 跨主机接入服务日志时使用;共用 Docker 网络可直接访问 ops-loki
# ports:
# - "3100:3100"
volumes:
- ./volume/data/mdis/loki/:/data/mdis/loki/
environment:
ROLE: loki
ENV_LOKI_RETENTION: "720h" # 日志保留 30 天

ops-tempo:
image: *ops_image
restart: always
volumes:
- ./volume/data/mdis/tempo/:/data/mdis/tempo/
environment:
ROLE: tempo
ENV_TEMPO_RETENTION: "720h" # 链路数据保留 30 天

ops-alloy:
image: *ops_image
restart: always
# 需要通过宿主机地址接收 OTLP 数据时,按所需协议取消对应端口映射的注释
# ports:
# - "4317:4317" # OTLP gRPC 接收端口
# - "4318:4318" # OTLP HTTP 接收端口
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- ./volume/data/mdis/alloy/:/data/mdis/alloy/
environment:
ROLE: alloy
ENV_OPS_SUB_PATH: *ops_sub_path
ENV_TEMPO_GRPC_URL: "http://ops-tempo:4317"
ENV_PROMETHEUS_REMOTE_WRITE_URL: "http://ops-prometheus:9090/prometheus/server/api/v1/write"
ENV_LOKI_PUSH_URL: "http://ops-loki:3100/loki/api/v1/push"

# 保存运维平台的数据源、告警及慢查询历史等数据
ops-mongo:
image: *ops_image
restart: always
environment:
ROLE: mongo
volumes:
- ./volume/data/mdis/mongo/:/data/mdis/mongo

agent:
image: *ops_image
restart: always
environment:
<<: *common_env
ROLE: agent

nodeagent:
image: *ops_image
restart: always
volumes:
- /:/host:ro,rslave
network_mode: host
pid: host
environment:
<<: *common_env
ROLE: nodeagent

# 复用 HAP/HDP 所在的 Docker 网络;如网络名称不同,请修改为实际名称
networks:
default:
external: true
name: script_default

保存文件前,必须将以下环境变量的示例值替换为实际值:

环境变量说明
ENV_OPS_TOKEN运维平台登录令牌,请使用高强度口令
ENV_ALERT_CRYPTO_KEY凭据加密密钥,请单独生成并妥善保存。如后期修改密钥,已保存的加密凭据将无法解密

可执行两次以下命令,分别为登录令牌和凭据加密密钥生成随机值,并填入对应环境变量:

openssl rand -hex 16

示例中的数据保存在部署目录下的 volume/data/mdis/,包括监控指标、日志和运维平台 MongoDB 数据。

Loki 日志默认存储在本地,也可使用对象存储进行存储。

4. 启动运维平台​

检查配置文件格式。根据服务器使用的 Docker Compose 命令,执行以下命令之一;未发现配置错误时,命令正常退出:

docker compose -f /data/mingdao/mdis/ops.yaml config --quiet
docker-compose -f /data/mingdao/mdis/ops.yaml config --quiet

创建启动脚本:

cat > /data/mingdao/mdis/start.sh <<'EOF'
#!/usr/bin/env bash

script_dir="$(dirname -- "$(readlink -f -- "${BASH_SOURCE[0]}")")"

if docker compose version >/dev/null 2>&1; then
docker compose -f "$script_dir/ops.yaml" up -d
else
docker-compose -f "$script_dir/ops.yaml" up -d
fi
EOF

创建停止脚本:

cat > /data/mingdao/mdis/stop.sh <<'EOF'
#!/usr/bin/env bash

script_dir="$(dirname -- "$(readlink -f -- "${BASH_SOURCE[0]}")")"

if docker compose version >/dev/null 2>&1; then
docker compose -f "$script_dir/ops.yaml" down
else
docker-compose -f "$script_dir/ops.yaml" down
fi
EOF

添加脚本执行权限:

chmod +x /data/mingdao/mdis/start.sh /data/mingdao/mdis/stop.sh

启动服务:

/data/mingdao/mdis/start.sh

后续如需停止运维平台,可执行:

/data/mingdao/mdis/stop.sh

5. 访问与验证​

查看容器运行状态:

docker ps -a

确认运维平台各容器的状态为 Up 后,在浏览器访问:

http://部署服务器IP:48881/mdis/web/

使用配置文件中的 ENV_OPS_TOKEN 登录,并确认概览页面正常显示。如修改了 ENV_OPS_SUB_PATH,请将访问地址中的 /mdis 替换为实际路径。

示例通过 YAML 锚点统一 gateway、Grafana 和 Alloy 等组件的访问子路径,修改时保持引用关系;使用根路径时填写 ""。

如果容器未正常运行,可根据 docker ps -a 输出中的容器名称查看日志:

docker logs --tail 100 容器名称

将命令中的 容器名称 替换为实际名称。其他排查方法见常见问题。

后续接入​

部署完成后,可根据需要进行以下配置:

  • 在数据源管理中添加需要监控的主机和中间件,或添加自定义页面。
  • 在 HAP/HDP 服务侧配置日志推送地址,接入服务日志。
  • 如需监控其他服务器,在目标服务器部署 Node Exporter。
  • 如需监控 Kubernetes 集群,在目标集群部署采集组件。

运维平台会通过 Alloy 自动采集部署服务器上的容器日志。链路追踪仅适用于 HAP/HDP Kubernetes 环境下运行,详见链路追踪。