Global Configuration Management的日志文件和日志配置

如果您遇到错误或异常，那么可以使用日志文件来研究问题并找出解决方案。

以下日志文件与Global Configuration Management相关：
  • gc.log：Global Configuration Management应用程序和服务的日志记录。
  • gcTrsRepair.log：Global Configuration Management资源集 (TRS) 的修复操作日志。
  • gcSdkContributionCache.log：缓存更新事件日志。 虽然会创建文件，但只有启用时才会记录事件。
注意：您的日志名称可能不同。 日志名称前缀 (gc) 基于默认应用上下文根，名称可在日志配置文件中自定义。
日志文件的默认位置取决于应用服务器：
  • 自由："JazzInstallDir/server/logs
  • IBM WebSphere®: WASInstallDir/server/profiles/<profile_name>/logs

日志记录配置

Global Configuration Management的日志配置可在 "JazzInstallDir/server/conf/<gcContextRoot>/log4j2.xml的 "log4j2.xml文件中找到。 可根据具体要求修改配置。

更改日志文件的位置
在 "log4j2.xml文件中找到这一行：
<Property name="baseDir">logs</Property>
将值（"logs"）改为您喜欢的目录路径。 例如，
<Property name="baseDir">/tmp/logs</Property>
管理日志文件的大小
在 "log4j2.xml文件中，日志文件的默认大小为 10 MB，备份文件的数量为 5。 您可以根据需要更改 "log4j2.xml文件中的滚动属性。
要更改基于大小的滚动，请更新以下各行中的数字：
<SizeBasedTriggeringPolicy size="10MB"/>
<DefaultRolloverStrategy max="5"/>
管理翻转日志文件的名称
在 "log4j2.xml文件中找到字符串
filePattern="${baseDir}/${app}-%i.log">
想怎么改就怎么改。 例如，
filePattern="${baseDir}/${app}.log.%i">

这会将滚动日志文件名设置为 "gc.log.1，而不是默认的 "gc-1.log。

更改所有日志文件中事件的时间戳
在 "log4j2.xml文件中找到以下一行
<Property name="pattern">%d{ISO8601_OFFSET_DATE_TIME_HHMM} [%30t] %5p %-50.50c %X{Tid} - %m%n</Property>
根据需要更改。 例如，
<Property name="pattern">"%d{dd MMM yyyy HH:mm:ss,SSS} [%30t] %5p %-50.50c %X{Tid} - %m%n"</Property>
要只更改 "gc.log中的时间戳，请查找以下一行：
<RollingRandomAccessFile name="defaultGcLog" fileName="${baseDir}/${app}.log"
在上一行下面，按您的要求修改下面几行。
<PatternLayout pattern="${pattern}"/>
例如，
<PatternLayout pattern="%d{dd MMM yyyy HH:mm:ss,SSS} [%30t] %5p %-50.50c %X{Tid} - %m%n"/>

时间戳显示为 "08 Apr 2022 14:34:02,123。

将跟踪输出添加至应用程序日志
下面的示例显示了如何配置向 "gc.log文件输出最详细的信息。 此日志文件可帮助您发现特定操作的问题的详细信息。
  1. 在 "log4j2.xml文件中，配置 "Root logger以记录最细的级别--TRACE 和所有信息。
    查找以下行：
    <Root level="WARN">
    将此行更改为：
    <Root level="TRACE">
  2. 增大追加器文件的最大大小，以能够容纳其他输出。
    查找以下行：
    <RollingRandomAccessFile name="defaultGcLog" fileName="${baseDir}/${app}.log"
    在上一行下面，您会发现
    <SizeBasedTriggeringPolicy size="10MB"/>
    将此行更改为：
    <SizeBasedTriggeringPolicy size="100MB"/>
  3. 等待 10 秒钟让更改被接受，或者按照下一节所述重新加载配置。
对全局配置服务启用调试消息
本节供客户在IBM支持部门的指导下调试其工作环境中与Global Configuration Management应用程序有关的问题时参考。

如果指示您为全局配置服务启用日志记录，您可以在 "log4j2.xml文件中这样做。 IBM支持可帮助您使用记录的信息排除故障。

  • 将全局配置 API 服务记录器设置为 DEBUG（或 TRACE）。
    注：对服务方法的调用会记录输入参数和任何结果或异常。
    查找 "log4j2.xml中的一行：
    <Logger name="com.ibm.team.gc.service.internal.GcApiService" level="INFO" />
    用以下一行替换
    <Logger name="com.ibm.team.gc.service.internal.GcApiService" level="DEBUG" />
  • 添加 "DEBUG级别的全局配置前置服务日志记录器。
    查找以下行：
    <Logger name="com.ibm.team.gc.sdk.service.internal.GlobalConfigurationService" level="INFO" />
    在其下方插入以下几行：
    <Logger name="com.ibm.team.gc.web.frontservice" level="DEBUG" />
  • 添加 "DEBUG级别的HttpUtils日志记录器 。
    插入以下几行
    注意：此设置会记录Global Configuration Management向其他工具发出请求的详情以及返回的结果。
    <Logger name="com.ibm.team.gc.common.HttpUtils" level="DEBUG" />
  • 将配置前台服务记录器设置为 DEBUG（或 TRACE）。
    查找以下行：
    <Logger name="com.ibm.team.gc.service.front.ConfigurationFrontService" level="INFO" />
    用以下一行替换
    <Logger name="com.ibm.team.gc.service.front.ConfigurationFrontService" level="DEBUG" />

动态重载 "log4j2.xml文件

您对 "log4j2.xml所做的任何更改，默认情况下都会在大约 10 秒后被应用程序自动接收。 或者，可以按照以下步骤重新加载配置。

  1. 打开应用程序管理 -Global Configuration Management页面，重新加载设置。

    https://<hostname>:9443/<gcContextRoot>/admin#action=com.ibm.team.repository.admin.reloadLoggingSettings

  2. 单击重新装入日志设置。

    如果您在重新装入日志设置下看到以下消息，那么表明已成功重新装入：Log Settings reloaded = [true]