Java Logger日志记录器的日志文件命名规则

Java Logger 日志文件命名规则

一 通用命名规范

• 推荐采用统一格式：appName_logType_logName.log。各段含义如下：
  • appName：应用或服务的唯一标识，便于多应用同机部署时区分。
  • logType：日志类别，如 access、monitor、stats、error 等，用于按用途分类。
  • logName：具体业务或模块的描述，便于快速定位模块来源。
• 示例：mppserver_monitor_timeZoneConvert.log、messageserver_rabbitmqconsumer_monitor.log。
• 扩展建议：
  • 将错误日志与业务日志分离，便于检索与告警降噪。
  • 日志文件至少保留 15 天，重要系统可适当延长（结合磁盘与合规要求）。

二 JDK 内置 FileHandler 的命名规则

• 核心概念
  • 通过配置属性 java.util.logging.FileHandler.pattern 指定文件名模式；未显式配置时，默认模式为 “%h/java%u.log”。
  • 支持按大小滚动：当单个文件达到 limit（字节）时关闭并轮转；保留 count 个历史文件，旧文件会在基名后追加序号（0、1、2…）。
• 可用模式占位符
  • “/”：本地路径分隔符（跨平台）。
  • “%t”：系统临时目录（如 java.io.tmpdir）。
  • “%h”：用户主目录（user.home）。
  • “%g”：轮转文件的生成号（generation number）。
  • “%u”：用于解决冲突的唯一编号（在多实例争用同一日志目录时避免覆盖）。
  • “%%”：输出一个字面量百分号“%”。
• 命名与轮转示例
  • 示例 1：模式 “%t/java%g.log”、count=2 时，可能生成 /tmp/java0.log（当前）、/tmp/java1.log（历史）。
  • 示例 2：模式 “%h/myapp.log”、count=3 且未指定 %g 时，轮转文件会在基名后追加点号和序号：myapp.0.log、myapp.1.log、myapp.2.log。
  • 示例 3：默认模式 “%h/java%u.log” 会在 user.home 下生成如 java0.log、java1.log 等，以避免冲突。

三 常见框架的命名配置要点

• 使用 Log4j 1.x/2.x 或 Logback 时，文件名通过配置文件直接指定（如 FileAppender 的 File 属性或 RollingFileAppender 的 fileName/rollingPolicy），可按需采用上文的 appName_logType_logName.log 规范，并配合 SizeBasedTriggeringPolicy、TimeBasedTriggeringPolicy 等实现按大小/时间滚动与历史清理。
• 无论采用何种框架，建议将访问日志、监控日志、错误日志分文件输出，统一目录结构，便于运维与聚合分析（如 ELK 体系）。