mackerel/mackerel-agent

docker-mackerel-agent

镜像概述和主要用途

docker-mackerel-agent是Mackerel监控代理（mackerel-agent）的Docker镜像，用于在Docker环境中便捷部署Mackerel监控代理。该镜像可连接Mackerel服务，实现对服务器、容器及应用进程的全面监控，支持自定义配置以满足不同监控需求。

核心功能和特性

• 基础监控：通过挂载Docker套接字和数据目录，实现对主机和容器的基础指标采集与监控。
• 角色分配：支持通过环境变量为监控代理分配服务角色（SERVICE:ROLE），便于监控对象分类管理。
• 跨容器进程监控：通过Docker link功能，可监控其他容器内的应用进程（如memcached）。
• 主机自动退役：配置后可在容器停止时自动调用Mackerel API退役对应主机，简化监控对象生命周期管理。
• 灵活的环境变量配置：支持通过环境变量控制插件启用、日志级别等；布尔类型变量（如auto_retirement、enable_docker_plugin）支持0/非0值或省略控制开关状态。

使用场景和适用范围

• Docker环境中的服务器及容器监控需求。
• 多容器应用的跨容器进程监控场景（如监控memcached等中间件容器）。
• 需要自动管理监控主机生命周期（如临时环境主机自动退役）的场景。
• 需按服务角色（如web:app、db:master）分类监控对象的企业级监控场景。

使用方法和配置说明

基础使用

启动mackerel-agent容器，需将<APIKEY>替换为您的Mackerel API密钥：

bash
docker run -h `hostname` \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
  -e 'apikey=<APIKEY>' \
  -e 'enable_docker_plugin=1' \
  --name mackerel-agent \
  -d \
  docker.xuanyuan.run/mackerel/mackerel-agent

参数说明：

• -h hostname``：设置容器主机名与宿主机一致，确保监控识别准确性。
• -v /var/run/docker.sock:/var/run/docker.sock：挂载Docker套接字，启用容器监控功能。
• -v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/：挂载数据目录，持久化监控数据。
• -e 'apikey=<APIKEY>'：必填，设置Mackerel服务的API密钥。
• -e 'enable_docker_plugin=1'：启用Docker插件，监控容器相关指标。

分配角色

通过opts环境变量添加-role=<SERVICE:ROLE>参数为监控代理分配服务角色：

bash
docker run -h `hostname` \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
  -e 'apikey=<APIKEY>' \
  -e 'opts=-v -role=<SERVICE:ROLE>' \
  --name mackerel-agent \
  -d \
  docker.xuanyuan.run/mackerel/mackerel-agent

说明：-v启用详细日志，-role=<SERVICE:ROLE>指定角色（如web:app或db:slave），用于监控对象分类。

监控其他容器内的进程

如需监控其他容器内的进程（以memcached为例），按以下步骤操作：

1. 启动被监控容器：启动memcached容器并命名（如memcached）：

   bash
   docker run -d -P \
     --name memcached -p 11211:11211 \
     docker.xuanyuan.run/sylvainlasnier/memcached
   

2. 准备插件配置文件：在宿主机创建memcached插件配置文件，指定监控目标地址（通过Docker link自动注入的环境变量）：

   bash
   cat /etc/mackerel-agent/conf.d/memcached.conf
   [plugin.metrics.memcached]
   command = "/usr/local/bin/mackerel-plugin-memcached -host=$MEMCACHED_PORT_11211_TCP_ADDR"
   

3. 启动mackerel-agent并链接容器：挂载配置文件目录，通过--link连接memcached容器：

   bash
   docker run -h `hostname` \
     -v /var/run/docker.sock:/var/run/docker.sock \
     -v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
     -e 'apikey=<APIKEY>' \
     -e 'enable_docker_plugin=1' \
     --link memcached:memcached \
     -v /etc/mackerel-agent/conf.d:/etc/mackerel-agent/conf.d:ro \
     -e 'include=/etc/mackerel-agent/conf.d/*.conf' \
     --name mackerel-agent \
     -d \
     docker.xuanyuan.run/mackerel/mackerel-agent
   

主机自动退役

配置auto_retirement=1环境变量，使容器停止时自动退役Mackerel主机：

bash
docker run -h `hostname` \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
  -e 'apikey=<APIKEY>' \
  -e 'auto_retirement=1' \
  -e 'enable_docker_plugin=1' \
  -d \
  docker.xuanyuan.run/mackerel/mackerel-agent

注意：需替换<APIKEY>为实际API密钥。容器停止时，代理会调用Mackerel API退役对应主机（详情参见官方文档）。

布尔环境变量说明

布尔类型环境变量（auto_retirement和enable_docker_plugin）的取值规则：

• 设为0或省略该环境变量时，值为false。
• 设为非0值（如1）时，值为true。
• 示例：禁用自动退役可使用-e 'auto_retirement=0'或不添加该-e参数。