Nginx-Proxy/Docker-Gen 中的 Logrotate 模板解析与配置指南

模板功能概述

nginx-proxy/docker-gen 项目中的 logrotate.tmpl 模板文件是一个用于自动生成 logrotate 配置的模板，专门针对 Docker 容器日志进行轮转管理。该模板能够根据容器环境变量自动配置日志文件的轮转策略，确保容器日志不会无限增长占用磁盘空间。

模板工作机制

该模板通过以下机制工作：

1. 从容器环境变量 LOG_FILES 中读取需要轮转的日志文件路径（支持逗号分隔的多个路径）
2. 为每个指定的日志文件生成独立的 logrotate 配置块
3. 自动包含容器的 JSON 日志文件（标准 Docker 日志格式）
4. 为不同类型的日志应用不同的轮转策略

配置详解

环境变量指定的日志文件配置

对于通过 LOG_FILES 环境变量指定的日志文件，模板应用以下配置：

daily              # 每天轮转一次日志
missingok          # 如果日志文件不存在也不报错
rotate 52          # 保留52个轮转后的日志文件（约一年的历史）
compress           # 压缩旧日志
delaycompress      # 延迟压缩（压缩前一个轮转周期的日志）
notifempty         # 如果日志为空则不轮转
create 644 root root # 新创建的日志文件权限为644，属主为root

容器标准JSON日志配置

对于Docker容器默认的JSON日志文件，模板应用以下配置：

daily              # 每天轮转一次
missingok          # 允许日志文件不存在
rotate 7           # 只保留7个轮转日志（一周的历史）
compress           # 压缩旧日志
delaycompress      # 延迟压缩
notifempty         # 空日志不轮转
create 644 root root # 新日志文件权限

实际应用场景

典型部署示例

假设我们有一个需要管理多个日志文件的容器，可以这样启动：

docker run -e LOG_FILES="/var/log/nginx/access.log,/var/log/nginx/error.log" ...

生成的 logrotate 配置将包含三个部分：

1. /var/log/nginx/access.log 的轮转配置
2. /var/log/nginx/error.log 的轮转配置
3. 容器标准JSON日志的轮转配置

配置建议

1. 生产环境调整：对于高流量网站，可能需要将JSON日志的rotate值从7增加到更大的数字
2. 敏感日志：对于包含敏感信息的日志，可以调整create权限为更严格的设置
3. 大日志文件：对于特别大的日志文件，考虑使用size参数替代daily，基于文件大小轮转

技术实现细节

模板使用了Go模板语言的以下特性：

1. range 循环遍历容器列表和日志文件列表
2. split 函数将逗号分隔的字符串拆分为数组
3. 条件判断 if 确保只在LOG_FILES存在时生成对应配置

路径构造方面，模板将日志文件路径拼接在容器文件系统的根路径下，确保能访问到容器内的真实日志文件位置。

常见问题解决

1. 权限问题：如果logrotate执行失败，检查生成的配置文件中create指令的权限设置
2. 日志不轮转：确认容器内时间设置正确，logrotate依赖系统时间决定何时轮转
3. 磁盘空间不足：适当减少rotate保留的日志数量或增加compress压缩级别

通过合理配置这个模板，可以有效地管理Docker容器的日志文件，避免因日志增长导致的磁盘空间问题，同时保留足够的历史日志供排查问题使用。