Apache APISIX 日志轮转插件配置指南

日志轮转是系统运维中一个非常重要的功能，它能够有效管理日志文件的大小和数量，避免磁盘空间被占满。Apache APISIX 提供了 log-rotate 插件来实现这一功能，但在实际使用中需要注意一些配置细节。

日志轮转插件的工作原理

log-rotate 插件通过定期检查日志文件的大小或创建时间，自动对日志文件进行轮转。轮转后的日志文件会被重命名并压缩保存，同时删除过期的旧日志文件。

常见配置问题分析

很多用户在配置 log-rotate 插件时会遇到插件不生效的问题，这通常是由于以下原因造成的：

1. 插件未正确加载：虽然用户在自定义配置文件中添加了插件名称，但没有完整配置所有必要的插件参数。

2. 配置优先级问题：APISIX 会合并默认配置和自定义配置，如果只部分覆盖配置可能导致插件无法正常工作。

3. 路径权限问题：日志文件所在目录可能没有写入权限，导致轮转失败。

正确配置方法

要使 log-rotate 插件正常工作，需要在 APISIX 的配置文件中进行完整配置：

deployment:
  plugins:
    - log-rotate
  plugin_attr:
    log_rotate:
      interval: 3600  # 轮转间隔时间(秒)
      max_kept: 24    # 保留的日志文件数量
      max_size: 100   # 单个日志文件最大大小(MB)

关键配置参数说明：

• interval：设置日志轮转的检查间隔时间，单位为秒
• max_kept：设置保留的历史日志文件数量
• max_size：设置触发轮转的单个日志文件大小阈值，单位为MB

最佳实践建议

1. 完整配置原则：在自定义配置文件中，不仅要列出插件名称，还要提供完整的插件属性配置。

2. 合理设置参数：

   • 生产环境中建议将 interval 设置为 86400（1天）
   • max_size 根据业务日志量合理设置
   • max_kept 根据磁盘空间和日志保留需求设置

3. 权限检查：确保 APISIX 进程对日志目录有读写权限。

4. 监控机制：建议设置监控检查日志轮转是否正常执行。

通过以上配置和注意事项，可以确保 APISIX 的日志轮转功能正常工作，有效管理系统日志文件。