docker-collector-logs 镜像文档

镜像概述

docker-collector-logs 是一个基于 Docker 的容器，通过 Filebeat 收集其他 Docker 容器的日志，并将日志转发至用户的 Logz.io 账户。该镜像通过挂载 Docker 相关文件获取容器元数据，结合环境变量动态生成 Filebeat 配置，实现日志的自动化收集与转发。

注意：本镜像仅用于日志收集。如需向 Logz.io 发送指标，请使用 docker-collector-metrics。

核心功能与特性

• 日志收集引擎：基于 Filebeat 实现高效的 Docker 容器日志采集
• 元数据获取：通过挂载 /var/run/docker.sock 和 /var/lib/docker/containers 目录，自动获取容器元数据（如容器名称、ID 等）
• 动态配置生成：通过环境变量参数动态生成 Filebeat 配置，无需手动编写配置文件
• 日志类型与编码控制：支持自定义日志类型（LOGZIO_TYPE）和编码格式（LOGZIO_CODEC，如 JSON 或 plain 文本）
• 容器日志过滤：可通过容器名称匹配（matchContainerName）或跳过（skipContainerName）特定容器日志
• 额外字段扩展：支持通过 additionalFields 添加自定义字段，丰富日志上下文信息
• 默认过滤规则：默认忽略自身容器（docker-collector-logs）及 docker-collector-metrics 容器的日志

使用场景

• 多容器应用日志聚合：集中收集分布式应用中多个 Docker 容器的日志，统一转发至 Logz.io
• 跨环境日志管理：在开发、测试、生产等不同环境中，标准化 Docker 日志收集流程
• Logz.io 日志集成：需将 Docker 容器日志发送至 Logz.io 进行存储、分析与可视化的场景

使用方法

5.1 前提条件

• 已安装 Docker 环境
• 拥有 Logz.io 账户，并获取账户 token（获取路径）
• 知晓 Logz.io 账户所在地区对应的 listener URL（根据账户地区选择，如 US 地区为 listener.logz.io，EU 地区为 listener-eu.logz.io）

5.2 拉取镜像

通过以下命令拉取镜像：

shell
docker pull logzio/docker-collector-logs

5.3 运行容器

使用 docker run 命令启动容器，需指定必要的环境变量和挂载卷。示例命令如下：

shell
docker run --name docker-collector-logs \
--env LOGZIO_TOKEN="<ACCOUNT-TOKEN>" \
--env LOGZIO_URL="<LISTENER-URL>:5015" \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-v /var/lib/docker/containers:/var/lib/docker/containers \
logzio/docker-collector-logs

卷挂载说明：

• /var/run/docker.sock:/var/run/docker.sock:ro：只读挂载 Docker 套接字，用于获取容器元数据
• /var/lib/docker/containers:/var/lib/docker/containers：挂载 Docker 容器日志存储目录，用于读取原始日志文件

5.4 配置参数说明

容器通过环境变量进行配置，参数说明如下：

验证日志是否送达

启动容器后，等待数分钟（日志传输需要时间），登录 Logz.io 账户，打开 Kibana 即可查看收集的日志。

版本更新日志

• 0.0.3：支持添加额外字段（additionalFields）
• 0.0.2：新增日志类型（LOGZIO_TYPE）和编码格式（LOGZIO_CODEC）配置选项