Tomcat 6.0 日志处理

openkk 13年前

本文主要讲的是 Tomcat 自己本身对日志的处理,而非每个 webapp 的日志配置(现在 webapp 一般会独立配置日志)。

内容基本上来自官方文档:http://tomcat.apache.org/tomcat-6.0-doc/logging.html

一、Webapp 记录日志的方法

Tomcat 中的 webapp 有三种方法记录日志:

  • 使用 java.util.logging
  • 使用 Servlet 标准中的日志记录方法 javax.servlet.ServletContext.log(...)
  • 使用任意其它的日志框架(例如 Log4j)

一般来说,每个 webapp 使用的日志框架都是独立的,不会影响其他 webapp。但如果用的是 Java 原生的 java.util.logging,由于它是通过系统加载的,因此各个 webapp 之间会共享同一个日志配置。

二、什么是 JULI

Tomcat 默认会使用 java.util.logging (JUL) 日志框架,但重写了一些实现,以解决一个 JVM 中 JUL 只能使用一个配置文件的问题,满足多个 webapp 独立配置日志的需求。这个实现就叫 JULI (['d?u:li])。

全局日志配置

  • 默认使用 ${catalina.base}/conf/logging.properties,这个路径在 Tomcat 启动脚本中通过 java.util.logging.config.file 系统属性指定
  • 如果上述默认配置文件不可用(不存在或无权限读取),则使用 JRE 中的 ${java.home}/lib/logging.properties

webapp 独立日志配置

  • JULI 支持每个 ClassLoader (也就是每个 webapp) 使用自己的日志配置,配置文件位于 {webapp]/WEB-INF/classes/logging.properties

控制台

  • 在 Linux 上运行 Tomcat 时,控制台的输出 (System.err/out) 同时会被保存到文件 catalina.out 中,这个名称是通过运行脚本指定的
  • 在 Windows 上,如果以服务的形式运行 Tomcat,也会将控制台输出保存到文件(文档没说文件名是什么。。。),如果不以服务的形式运行,则不会保存控制台输出

三、JULI 对 JUL 的扩展

  • 配置文件中能通过 ${systemPropertyName} 的格式使用系统属性
  • Handler
    • JUL 中,handler 名称即为类的完整限定名,一个类只能创建一个 handler。而 JULI 的 handler 名称可以在类的完整限定名之前加前缀,该前缀以数字开头,以 . 结尾(注意中间不能出现 .),例如 5portallocal.
    • JULI 定义一些 handler 类,例如 org.apache.juli.FileHandler,支持缓冲。
  • Logger
    • 每个 logger 可以指定多个 handler(Java 6 的 JUL 开始支持)
    • root logger 可以使用 .handler 指定 handler:
    </ul>
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].useParentHandlers = true
      • 注意,如果一个 logger 已经指定了 handler,则默认不会将日志传递给上级 logger,但可以通过 useParentHandlers 修
      </ul>

      org.apache.catalina.core.ContainerBase.[Catalina].[localhost].useParentHandlers = true

      四、生产环境中的注意事项

      • root logger 默认配置了 FileHandler 和 ConsoleHandler,而控制台输出一般又被保存到文件中,导致相同的日志被保存了2份,可以考虑将 ConsoleHandler 从 root logger 中去除。
      • 删除没必要的 handler,例如 host-manager 的。
      • handler 默认使用系统默认编码,可以考虑显式指定编码。
      • 考虑配置 access log,可参考 http://tomcat.apache.org/tomcat-6.0-doc/config/valve.html#Access_Log_Valve

      五、其它

      Tomcat 也能配置为使用 Log4j 代替 JULI 来处理日志,详见 http://tomcat.apache.org/tomcat-6.0-doc/logging.html#Using_Log4j