Logspout 使用指南

Logspout 是一个专为 Docker 容器日志设计的开源日志路由工具。它在 Docker 主机上运行，并收集所有容器的日志，然后将它们转发到您指定的目的地。

1. 项目目录结构及介绍

Logspout 的源代码结构通常包括以下几个关键部分：

.
├── docs       # 文档目录
├── modules     # 包含可扩展的日志处理模块
├── scripts     # 脚本目录，可能包含构建或测试脚本
├── main.go     # 主程序文件，启动 Logspout 的入口点
└── Dockerfile  # Docker 镜像构建文件

• docs: 项目相关文档。
• modules: 存放用于处理和路由不同日志格式的模块。
• scripts: 含有辅助脚本，例如构建镜像或执行测试。
• main.go: Go 语言编写的主程序，实现 Logspout 的核心逻辑。
• Dockerfile: 用于构建 Logspout Docker 镜像的文件。

2. 项目的启动文件介绍

主要的启动文件是 main.go，它包含了 Logspout 应用程序的主要逻辑。当 Logspout 运行时，它会读取 Docker.sock 文件以监听容器的启动和停止事件，然后根据配置将这些容器的日志发送到指定的日志服务器。

在命令行中启动 Logspout，您可以使用以下命令：

docker run --name="logspout" \
--volume=/var/run/docker.sock:/var/run/docker.sock \
gliderlabs/logspout <ROUTE>

这里的 <ROUTE> 指定要将日志路由到的地址（如 syslog、HTTP 等）。

3. 项目的配置文件介绍

Logspout 本身并不依赖外部配置文件来运行。它的大部分配置是在运行时通过传递命令行参数来完成的，比如上面提到的 ROUTE。此外，可以通过环境变量或在启动时附加卷来扩展其功能。例如，可以设置 SYSLOG_TAG 环境变量来自定义 syslog 标签。

docker run -e SYSLOG_TAG=myapp ... gliderlabs/logspout syslog://example.com:514

在某些情况下，可以通过挂载自定义模块目录以启用额外的日志处理能力。例如，若要在本地模块目录 ./custom_modules 中添加自定义模块，可以这样启动：

docker run --volume "$(pwd)/custom_modules:/go/src/github.com/gliderlabs/logspout/modules" ...

请注意，Logspout 默认使用的是其内置的模块集。若需自定义模块，需了解如何编写和集成这些模块。

至此，您已经掌握了 Logspout 的基本概念以及如何启动和配置它。进一步了解和定制 Logspout 功能，建议查阅项目文档及示例代码。