deis/logspout

logspout

logspout是一个运行在Docker内部的日志路由器，它会连接到主机上的所有容器，收集其标准输出（stdout）和标准错误（stderr）日志，并将这些日志路由到指定目标位置。它是完全无状态的日志工具（除非持久化路由），仅用于日志转发，不管理日志文件或历史记录。

核心功能

• 收集所有Docker容器的stdout和stderr日志
• 支持将日志路由到远程syslog服务
• 提供HTTP API用于创建、查看、删除日志路由
• 实时查看聚合日志流（可按容器名称/ID、日志类型过滤）
• 支持WebSocket获取JSON格式日志
• 自定义时间戳格式
• 兼容服务发现工具（如Consul）的SRV记录解析

使用场景

1. 集中化日志管理：将所有容器日志转发到远程syslog服务（如Papertrail）进行集中存储
2. 实时调试：通过HTTP API查看实时日志流，快速定位容器问题
3. 自定义过滤：仅转发特定容器（如含"db"名称）或日志类型（如stderr）的日志
4. 服务发现集成：结合Consul自动发现日志聚合服务地址

配置说明

获取镜像

直接从Docker Hub拉取轻量级镜像：

bash
docker pull docker.xuanyuan.run/deis/logspout

基本使用

路由到远程syslog

挂载Docker socket并指定syslog目标地址：

bash
docker run -v /var/run/docker.sock:/tmp/docker.sock docker.xuanyuan.run/deis/logspout /bin/logspout syslog://logs.papertrailapp.com:55555

实时查看日志

暴露端口8000并通过curl查看：

bash
# 启动logspout
docker run -d -p 8000:8000 -v /var/run/docker.sock:/tmp/docker.sock docker.xuanyuan.run/deis/logspout
# 查看所有容器日志
curl $(docker port $(docker ps -lq) 8000)/logs
# 过滤含"db"的容器日志
curl $(docker port $(docker ps -lq) 8000)/logs/filter:db

创建自定义路由

通过HTTP API提交路由规则：

bash
curl $(docker port $(docker ps -lq) 8000)/routes -X POST \
  -d '{"source": {"filter": "db", "types": ["stderr"]}, "target": {"type": "syslog", "addr": "logs.papertrailapp.com:55555"}}'

自定义时间戳格式

设置环境变量指定格式：

bash
docker run -v /var/run/docker.sock:/tmp/docker.sock -e DATETIME_FORMAT="2006-01-02 15:04:05" docker.xuanyuan.run/deis/logspout

HTTP API详情

流式端点

• GET /logs：所有容器日志
• GET /logs/filter:<子串>：过滤容器日志
• GET /logs/id:<容器ID>：指定容器日志
• 添加Accept: application/json头获取JSON格式日志

路由资源

• 创建：POST /routes（提交JSON源和目标配置）
• 列出：GET /routes（返回所有路由）
• 查看：GET /routes/<路由ID>（返回路由详情）
• 删除：DELETE /routes/<路由ID>（删除指定路由）

许可证

本项目采用BSD许可证。