IBM® FileNet® Workplace XT 使用 Apache log4j 产品来管理其日志记录。在日志记录期间,关于应用程序活动的信息将写至诸如控制台或文件之类的输出位置。支持和开发人员使用日志条目中的信息来分析应用程序活动以及诊断并解决问题。日志记录仅用于诊断目的,它不提供安全性或审计跟踪信息。
将在 Workplace XT 安装期间安装 log4j 产品。缺省情况下,安装期间未启用日志记录。
要启用或禁用日志记录,请完成下列步骤:
配置日志记录设置
样本 log4j.properties 文件具有一组缺省选项,以关键字=值对的形式指定了这些选项。要更改缺省值,请使用文本编辑器打开 log4j.properties,进行必要的修改,然后保存该文件。可以在安装后的任何时候配置日志记录设置。 将自动识别您对日志记录配置文件作出的更改;您不必重新启动应用程序或应用程序服务器。
下列主题提供了一些关于您将在文件中看到的某些日志记录配置选项的信息。有关日志记录选项的更多信息,请访问“日志记录项目”下的 Apache Web 站点 (http://apache.org) 以及 Apache 日志记录 Web 站点 (http://logging.apache.org/log4j/)。
记录器
记录器将启用的日志记录请求写至追加器。在 log4j.properties 文件中,第一个关键字描述根记录器。根记录器是层次结构中级别最高的记录器并提供全局缺省值;任何未明确设置选项的子记录器将从根记录器继承行为。
追加器
您可以通过配置追加器来指定在何处写入日志数据,追加器将已安排格式的日志条目发送到指定的外部目标。目标类型可以是文件或控制台;可以将输出重定向至 Windows 事件日志、转发至远程 log4j 服务器等。(请参阅 Apache log4j 文档,以了解所有输出目标和用于按排格式的选项。)单个记录器可以具有多个追加器。例如,您可以将输出同时写至控制台和文件。增加目标数目会影响性能。
在 Workplace XT 中,缺省情况下将配置两个追加器。一个追加器以 IBM 公共基本事件 (CBE) 格式写入日志数据,IBM Support Assistant 工具使用该格式来处理日志,另一个追加器以更便于用户理解的格式写入日志数据。您可以更改后一个追加器以减少输出量,也可以完全关闭此追加器。
级别
您指定的日志记录级别确定收集的信息的类型和数量。收集的信息量与对系统的性能影响之间存在直接相关性。
Workplace XT 应用程序日志支持标准 INFO、WARN、ERROR 和 FATAL 级别以及 ALL 和 OFF 级别。下表简要地描述了这些标准级别;请参阅 Apache log4j 文档以了解关于级别的更多信息。
级别 | 描述 |
---|---|
INFO | 请求在粗颗粒度级别下描述应用程序进度的参考消息。 |
WARN | 请求记录有潜在危害的情况。 |
ERROR | 请求记录从应用程序中抛出的异常。 |
FATAL | 请求仅记录非常严重的错误事件,这些事件可能导致应用程序失败。 |
您指定的级别确定收集的信息量。收集的信息量与对系统的性能影响之间存在直接相关性。
输出文件格式
配置追加器时,可以使用布局关键字来指定写入数据的格式。可以选择 PatternLayout 和 ConversionPattern。PatternLayout 用于指定日志条目的特定模式,而 ConversionPattern 则用于定义该模式,它可以识别写至追加器的元素模式。请参阅以下示例:
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n
将产生以下已安排格式的日志条目:
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
有关用于安排格式的选项的更多信息,请参阅 Apache log4j 文档。
分析输出
支持人员可以检查日志文件中的条目,以分析应用程序活动和诊断应用程序中出现的问题。另外,使用 IBM Support Assistant (ISA) 工具将使分析阶段自动执行。ISA 工具使用 log4j 的记录输出中的 CBE 条目。
您还可以使用诸如 Apache Chainsaw(一个基于 GUI 的日志查看器)之类的工具来亲自检查非 CBE 的日志条目。