soramitsukhmer/logspout

Logspout Docker镜像文档

镜像概述

Logspout是一个轻量级Docker日志收集工具，可自动收集Docker容器产生的日志，并转发至指定的日志处理服务（如Logstash）。本镜像旨在通过简单配置集成到现有Docker Compose环境中，实现容器日志的集中管理。

核心功能与特性

• 自动日志收集：通过访问Docker守护进程，自动发现并收集所有运行中容器的日志
• 灵活的日志转发：支持将日志发送至Logstash等目标服务
• 容器元数据附加：可包含Docker容器标签等元数据，便于日志分析
• 启动重试机制：支持启动失败时自动重试，提高服务稳定性
• 调试支持：提供DEBUG模式，便于问题排查

使用场景

• 开发/测试环境中容器日志的集中收集与查看
• 生产环境中容器日志的统一转发与存储
• 需要将Docker容器日志与Logstash等日志分析平台集成的场景

使用方法

Docker Compose集成

在现有docker-compose.yml中添加logspout服务即可快速启用：

yaml
version: '3'

services:
  logspout:
    image: soramitsukhmer/logspout
    restart: on-failure
    ports:
      - '5005:80'  # 可选，暴露日志API端口
    environment:
      ALLOW_TTY: "true"          # 允许收集TTY设备日志
      DEBUG: "true"              # 启用调试模式
      ROUTE_URIS: logstash://192.168.0.239:5000  # 日志转发目标（Logstash地址）
      DOCKER_LABELS: "true"      # 包含Docker容器标签信息
      # LOGSPOUT: 'ignore'       # 可选，设置为'ignore'可排除自身日志
      # LOGSTASH_FIELDS: environment=docker  # 可选，添加自定义字段到日志
      RETRY_STARTUP: "true"      # 启动失败时自动重试
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 必须，用于访问Docker守护进程
    network_mode: "host"  # 使用主机网络模式，确保日志转发网络可达

配置参数说明

环境变量

卷挂载

• 必须挂载/var/run/docker.sock至容器内相同路径，Logspout通过此套接字与Docker守护进程通信，获取容器日志和元数据。

网络模式

• 示例中使用host网络模式，确保Logspout能直接访问日志转发目标（如Logstash），也可根据实际网络环境调整为自定义网络。

注意事项

• 确保Docker守护进程的套接字文件/var/run/docker.sock存在且容器有访问权限
• ROUTE_URIS需根据实际日志接收服务（如Logstash）的地址和端口进行配置
• 生产环境中建议关闭DEBUG模式以减少日志输出量
• 若需排除特定容器日志，可在目标容器标签中添加logspout: ignore