quiq/logspout

quiq/logspout 镜像文档

镜像概述和主要用途

quiq/logspout是gliderlabs/logspout的分支版本，由Quiq维护（源码仓库：https://github.com/Quiq/logspout%EF%BC%89%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E5%9F%BA%E4%BA%8EAlpine 3.7构建，主要功能是收集Docker容器日志并转发至指定目标。相比原版本，此分支增强了稳定性，尤其与LogDNA日志管理平台兼容性良好，适用于Docker环境下的日志集中收集与转发场景。

核心功能和特性

• 轻量级基础：基于Alpine 3.7镜像，体积小且资源占用低
• 稳定性增强：针对原logspout进行优化，提升运行稳定性（具体变更见：https://github.com/Quiq/logspout/blob/master/ABOUT_THIS_FORK.md%EF%BC%89
• LogDNA兼容：完美支持LogDNA日志平台的日志转发需求
• 安全运行：以非root用户（nobody）身份运行，降低安全风险
• 灵活配置：支持通过环境变量配置日志格式、超时时间、HTTP端口等参数
• Docker原生集成：通过挂载docker.sock实现对容器日志的直接读取

使用场景和适用范围

适用于需要集中收集、转发Docker容器日志的环境，特别推荐用于使用LogDNA进行日志管理的场景。可部署在Docker主机上，实时收集所有运行中容器的日志并转发至LogDNA或其他支持syslog协议的日志平台。

使用方法和配置说明

Dockerfile说明

dockerfile
FROM alpine:3.7

# 安装CA证书，确保TLS连接正常
RUN apk add --no-cache ca-certificates
# 添加logspout可执行文件到/opt目录
ADD logspout /opt/

# 切换到nobody用户运行，增强安全性
USER nobody
# 设置入口点为logspout可执行文件
ENTRYPOINT ["/opt/logspout"]

部署示例（Ansible）

以下是使用Ansible部署logspout容器并对接LogDNA的示例：

yaml
- name: Start Logspout container
  docker_container: 
    name: logspout  # 容器名称
    labels: {"name": "logspout"}  # 容器标签
    image: quiq/logspout:20171026  # 使用指定版本镜像
    command: syslog+tls://syslog-a.logdna.com:NNNNN  # 日志转发目标（LogDNA的syslog TLS地址）
    state: started  # 确保容器处于运行状态
    restart_policy: always  # 设置自动重启策略
    groups: 999  # 加入docker组（GID 999），以允许读取docker.sock
    read_only: True  # 使用只读文件系统，增强安全性
    env:  # 环境变量配置
      SERVICE_IGNORE=1  # 忽略服务发现（如Consul）
      SYSLOG_STRUCTURED_DATA='logdna@NNNNN key="XXXX" tags="{{cluster}}"'  # LogDNA结构化数据（包含API密钥和标签）
      SYSLOG_HOSTNAME="{{ ansible_nodename }}"  # 日志中的主机名（使用Ansible节点名称）
      SYSLOG_TAG='{{ '{{' }} index .Container.Config.Labels "name" {{ '}}' }}'  # 日志标签（使用容器的"name"标签）
      INACTIVITY_TIMEOUT=1m  # 连接不活动超时时间
      HTTP_PORT=8080  # HTTP接口端口（用于状态查询等）
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 挂载docker.sock以读取容器日志

关键参数说明

• groups: 999：Docker组的GID通常为999，加入该组允许容器内的nobody用户读取/var/run/docker.sock
• volumes：必须挂载/var/run/docker.sock，logspout通过此文件获取容器日志信息
• command：指定日志转发目标，格式为syslog+tls://<目标地址>:<端口>，对于LogDNA需使用其提供的syslog TLS地址
• 环境变量：
  • SYSLOG_STRUCTURED_DATA：LogDNA认证信息，需替换NNNNN（LogDNA账户ID）和XXXX（API密钥）
  • SYSLOG_HOSTNAME：日志中显示的主机名，建议设置为Docker主机名
  • SYSLOG_TAG：日志标签，示例中使用容器的"name"标签作为标识
  • INACTIVITY_TIMEOUT：设置连接超时时间，避免空闲连接占用资源
  • HTTP_PORT：启用HTTP接口，可用于查询logspout运行状态