portainer/template-swarm-monitoring

监控Swarm应用模板镜像文档

1. 镜像概述和主要用途

本镜像集合是Portainer监控Swarm应用模板（monitoring Swarm App Template）的核心组件，由Portainer官方维护，源码托管于https://github.com/portainer/templates/blob/master/images/monitoring/Makefile%E3%80%82%E5%85%B6%E4%B8%BB%E8%A6%81%E7%94%A8%E9%80%94%E6%98%AF%E4%B8%BADocker Swarm集群提供开箱即用的监控能力，集成指标收集、数据可视化、服务健康检查等功能，支持Swarm环境下容器、服务及主机资源的全方位监控。

2. 核心功能和特性

2.1 核心功能

• 多维度指标收集：支持容器CPU/内存/网络/磁盘使用率、Swarm服务状态、主机系统资源（CPU/内存/磁盘I/O）等指标采集。
• 数据可视化：内置监控面板，直观展示集群运行状态及性能趋势。
• 服务发现：自动发现Swarm集群中的服务及容器，无需手动配置目标端点。
• 告警集成：支持自定义告警规则，针对异常指标触发通知（如邮件、Slack等）。

2.2 关键特性

• 轻量级部署：基于Alpine或Debian Slim基础镜像，镜像体积小，资源占用低。
• Swarm原生支持：适配Swarm服务滚动更新、副本扩缩容场景，监控配置自动同步。
• 持久化存储：支持挂载数据卷持久化监控数据，避免容器重启导致数据丢失。
• 可扩展性：支持集成第三方监控工具（如Prometheus、Grafana），扩展监控能力。

3. 使用场景和适用范围

3.1 适用场景

• Docker Swarm集群日常运维监控
• 容器化应用性能瓶颈分析
• 服务健康状态实时检查
• 资源使用率趋势追踪与容量规划

3.2 适用范围

• 环境类型：开发、测试及生产环境的Docker Swarm集群。
• 集群规模：支持中小型Swarm集群（建议节点数≤50），大型集群需额外配置资源。
• 用户群体：DevOps工程师、系统管理员、集群运维人员。

4. 使用方法和配置说明

4.1 获取镜像

4.1.1 从仓库拉取（推荐）

镜像通过Docker Hub或Portainer私有仓库分发，具体镜像名称可参考GitHub仓库的Makefile定义，典型镜像标签格式为：
portainer/monitoring-swarm:<组件>-<版本>（如portainer/monitoring-swarm:prometheus-v2.45.0）。

拉取命令示例：

bash
docker pull portainer/monitoring-swarm:prometheus-v2.45.0

4.1.2 本地构建

若需自定义配置，可基于GitHub源码构建：

bash
git clone https://github.com/portainer/templates.git
cd templates/images/monitoring
make build  # 执行Makefile构建镜像，具体参数可通过Makefile变量调整

4.2 基本使用示例（docker run）

以下为单容器运行示例（以Prometheus组件为例，实际部署需结合Swarm服务模式）：

bash
docker run -d \
  --name monitoring-prometheus \
  --network=swarm-monitoring \  # 需提前创建监控专用网络
  -p 9090:9090 \
  -v /var/run/docker.sock:/var/run/docker.sock \  # 挂载Docker套接字用于服务发现
  -v prometheus-data:/prometheus \  # 持久化数据卷
  -e SWARM_MODE=true \  # 启用Swarm模式适配
  -e SCRAPE_INTERVAL=15s \  # 指标采集间隔
  portainer/monitoring-swarm:prometheus-v2.45.0

4.3 Docker Compose配置示例

适用于Swarm集群的docker-compose.yml示例（集成Prometheus和Grafana）：

yaml
version: '3.8'

networks:
  monitoring-net:
    driver: overlay  # Swarm overlay网络，跨节点通信

volumes:
  prometheus-data:
  grafana-data:

services:
  prometheus:
    image: portainer/monitoring-swarm:prometheus-v2.45.0
    deploy:
      placement:
        constraints: [node.role == manager]  # 部署在Swarm管理节点
      replicas: 1
    ports:
      - "9090:9090"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - prometheus-data:/prometheus
    environment:
      - SWARM_MODE=true
      - SCRAPE_INTERVAL=15s
      - RETENTION_TIME=15d  # 数据保留时间
    networks:
      - monitoring-net

  grafana:
    image: portainer/monitoring-swarm:grafana-v10.1.0
    deploy:
      replicas: 1
    ports:
      - "3000:3000"
    volumes:
      - grafana-data:/var/lib/grafana
    environment:
      - GF_SECURITY_ADMIN_PASSWORD=admin  # 初始管理员密码
      - GF_PROMETHEUS_URL=http://prometheus:9090  # 关联Prometheus数据源
    networks:
      - monitoring-net

部署命令：

bash
docker stack deploy -c docker-compose.yml monitoring-stack

4.4 配置参数和环境变量

通用环境变量

组件专用参数（以Prometheus为例）

5. 镜像构建方法（基于Makefile）

源码仓库中的Makefile定义了镜像构建逻辑，支持指定组件、版本及基础镜像等参数。

5.1 构建参数

5.2 构建命令示例

构建Grafana组件镜像：

bash
cd templates/images/monitoring
make build COMPONENT=grafana VERSION=v10.1.0 BASE_IMAGE=alpine:3.18

6. 注意事项

• 网络配置：Swarm集群中需使用overlay网络确保跨节点通信，监控组件需挂载/var/run/docker.sock以获取集群信息（生产环境建议限制权限）。
• 资源限制：根据集群规模调整容器CPU/内存限制，避免监控组件占用过多资源影响业务服务。
• 版本兼容性：镜像版本需与Swarm集群Docker Engine版本兼容（建议Docker Engine ≥ 20.10）。
• 数据备份：定期备份持久化卷数据（如prometheus-data、grafana-data），防止数据丢失。

7. 参考链接

• 镜像源码及构建脚本：https://github.com/portainer/templates/blob/master/images/monitoring/Makefile
• Portainer Swarm应用模板文档：Portainer官方文档