IBM Support

How to Enable Garbage Collection (GC) Logging on the TM1 Application Server

Troubleshooting


Problem

There may be times where Garbage Collection logging is required to diagnose a specific problem with the TM1 Application Server. This document outlines the steps required to enable Garbage Collection logging for the bundled Websphere Liberty Application Server.

Resolving The Problem

  1. Navigate to the \tm1_64\bin64\ directory on the TM1 Application Server
  2. Find and backup the bootstrap_wlp_tm1_winx64.xml file
  3. Open and edit the bootstrap_wlp_tm1_winx64.xml file with a text editor
  4. Search for the following parameter:
    <param condName="${java_vendor}" condValue="IBM">-Xgcpolicy:gencon</param>
  5. Insert a new line below the parameter found above, and paste the following:
    <param condName="${java_vendor}" condValue="IBM">-Xverbosegclog:verbosegc_%Y%m%d.%H%M%S.%pid.log,1,20000</param>
  6. Restart the IBM Cognos TM1 Application Service to enable the GC logging.

The Garbage Collection log file will be written to the \tm1_64\bin64\ directory as verbosegc_TIMESTAMP .

NOTE: The location "verbosegc" will get automatically created upon service restart within the BIN64 directory. To output to a new location, you can prepend the path before the filename, example below:
<param condName="${java_vendor}" condValue="IBM">-Xverbosegclog:c:\tm1\logs\verbosegc_%Y%m%d.%H%M%S.%pid.log,1,20000</param>

[{"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Not Applicable","Platform":[{"code":"PF033","label":"Windows"}],"Version":"2.0.1;2.0","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
15 June 2018

UID

swg22002245