giantswarm/eventrouter

docker-eventrouter 中文技术文档

镜像概述和主要用途

docker-eventrouter 是一个用于监听和处理 Docker 守护进程事件的工具。它能够捕获 Docker 引擎产生的各类事件（如容器创建、启动、停止、删除，镜像拉取、构建等），并可以将这些事件路由到不同的目标服务或存储系统进行处理和分析。

核心功能和特性

• 实时捕获 Docker 守护进程产生的各类事件
• 支持多种事件输出目标，如标准输出、文件、HTTP 端点、消息队列等
• 可配置的事件过滤机制，只关注特定类型的事件
• 轻量级设计，资源占用低
• 简单易用的配置方式

使用场景和适用范围

• Docker 容器生命周期监控和审计
• 容器集群事件集中收集和分析
• 基于容器事件触发自动化操作
• Docker 环境的日志聚合系统构建
• DevOps 流程中的事件响应和通知

详细的使用方法和配置说明

基本用法

使用 Docker 命令直接运行：

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  docker.xuanyuan.run/docker-eventrouter

Docker Compose 配置示例

yaml
version: '3'
services:
  eventrouter:
    image: docker.xuanyuan.run/docker-eventrouter
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - OUTPUT_TYPE=stdout
      - LOG_LEVEL=info
    restart: always

配置参数和环境变量

高级配置示例

过滤特定事件并输出到文件

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /host/logs:/var/log \
  -e OUTPUT_TYPE=file \
  -e OUTPUT_FILE_PATH=/var/log/docker-events.log \
  -e FILTER_TYPE=container \
  -e FILTER_ACTION=start,stop \
  docker.xuanyuan.run/docker-eventrouter

输出事件到 HTTP 端点

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e OUTPUT_TYPE=http \
  -e HTTP_ENDPOINT=http://example.com/webhook \
  docker.xuanyuan.run/docker-eventrouter

使用配置文件进行高级配置

创建配置文件 config.yaml：

yaml
docker:
  socket: /var/run/docker.sock
  
filters:
  types:
    - container
    - image
  actions:
    - start
    - stop
    - pull
    - push

output:
  type: http
  config:
    url: http://example.com/events
    method: POST
    timeout: 5s

然后运行容器并挂载配置文件：

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v $(pwd)/config.yaml:/etc/eventrouter/config.yaml \
  docker.xuanyuan.run/docker-eventrouter --config /etc/eventrouter/config.yaml

Docker 部署方案示例

docker-compose 完整配置

yaml
version: '3'

services:
  eventrouter:
    image: docker.xuanyuan.run/docker-eventrouter
    container_name: docker-eventrouter
    restart: always
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./config:/etc/eventrouter
      - ./logs:/var/log/eventrouter
    environment:
      - LOG_LEVEL=info
      - CONFIG_FILE=/etc/eventrouter/config.yaml
    networks:
      - monitoring-network

networks:
  monitoring-network:
    driver: bridge

Kubernetes 部署

yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: docker-eventrouter
  namespace: monitoring
spec:
  selector:
    matchLabels:
      app: docker-eventrouter
  template:
    metadata:
      labels:
        app: docker-eventrouter
    spec:
      containers:
      - name: docker-eventrouter
        image: docker.xuanyuan.run/docker-eventrouter
        volumeMounts:
        - name: docker-sock
          mountPath: /var/run/docker.sock
        - name: config-volume
          mountPath: /etc/eventrouter
        env:
        - name: LOG_LEVEL
          value: "info"
        - name: CONFIG_FILE
          value: "/etc/eventrouter/config.yaml"
      volumes:
      - name: docker-sock
        hostPath:
          path: /var/run/docker.sock
      - name: config-volume
        configMap:
          name: eventrouter-config

事件类型参考

docker-eventrouter 可以捕获的主要事件类型包括：

• container: 容器相关事件（create, start, stop, die, destroy, pause, unpause 等）
• image: 镜像相关事件（pull, push, build, tag, untag, delete 等）
• network: 网络相关事件（create, connect, disconnect, destroy 等）
• volume: 卷相关事件（create, mount, unmount, destroy 等）
• daemon: Docker 守护进程相关事件（reload, restart 等）
• plugin: 插件相关事件（install, enable, disable, remove 等）