Enabling and disabling remote diagnostic logging for the CICS® Transaction Gateway proxy

To facilitate troubleshooting, HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrators can view, download, and share detailed log events information for the CICS® Transaction Gateway proxy. The capability to display this information in Test Virtualization Control Panel requires enabling remote diagnostic logging for the proxy.

About this task

Test Virtualization Control Panel can display a diagnostic log that is a centralized view of log events of HCL DevOps Test Integrations and APIs (Test Integrations and APIs) agents and proxies.

By default, remote diagnostic logging to Test Virtualization Control Panel is not enabled in the CICS® Transaction Gateway proxy.

To enable or disable remote diagnostic logging for the CICS® Transaction Gateway proxy, you must specify certain Java™ system properties. The procedure is however different for Windows and non-Windows computers.
  • On Windows computers, the CICS Transaction Gateway runs as a service. To add parameters to the service, use the ctgservice.exe program that is found in the bin folder of the CTG installation; for example, C:\Program Files (x86)\IBM\CICS Transaction Gateway\bin. To verify the parameters, open the Windows registry and check the entry for the service. It can be at 
    HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\IBMCICSTransactionGateway\Parameters
    .
    The following command adds the proxy JAR to the classpath and enables DEBUG logging: 
    ctgservice.exe -R -A-classpath="C:\Program Files (x86)\IBM\CICS Transaction Gateway\classes\com.ibm.rational.rit.ctg.jar" -A-j-Dgreenhat.logappender.console.CONSOLE=layout:detailed,level:DEBUG
    .

  • On non-Windows computers, use the parameters with the ctgstart program that can be found in the bin folder of the CTG installation; for example, /opt/ibm/cicstg/bin.

    Following is an example:
    ./ctgstart -classpath=/opt/ibm/cicstg/classes/com.ibm.rational.rit.ctg.jar -j-Dgreenhat.logappender.console.CONSOLE=layout:detailed,level:DEBUG

Procedure

  1. Edit the Java™ system properties as shown in the following table:
    Table 1. Java™ system properties for enabling and disabling remote diagnostic logging for the CICS® Transaction Gateway proxy to Test Virtualization Control Panel
    To: Do the following:

    Enable remote diagnostic logging at debug level to Test Virtualization Control Panel

    Note: Available levels are error, warning, info, debug, and trace. The Java.Util.Logging (JUL) appender defaults to "level:debug" if level is not set, so all events are passed to Java.Util and filtered there by the separate configuration.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.net.NET=level:DEBUG -Dgreenhat.logappender.jul.JUL

    Enable remote diagnostic logging at debug level to Test Virtualization Control Panel and specify the URL for the network log appender.

    Note: Available levels are error, warning, info, debug, and trace. Instead of entering a specific URL, you can enter url:auto.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.net.NET=url:http://<IP address or hostname>,level:DEBUG -Dgreenhat.logappender.jul.JUL

    Enable remote diagnostic logging at debug level and internal logging to Test Virtualization Control Panel.

    Note: Available levels are error, warning, info, debug, and trace.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.net.NET=level:DEBUG -Dgreenhat.logappender.jul.JUL -Dgreenhat.loginternal=appender

    Enable remote diagnostic logging at error or warning level to Test Virtualization Control Panel

    Note: Default remote log level is warning.
    Note: The Java.Util.Logging (JUL) appender is not present, so there will be no local file logging.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.net.NET

    Enable console logging at debug level and use detailed layout.

    Note: If Java™ logging is not enabled, you might want to enable console logging. Console logging layout can be detailed, standard, or compact.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.console.CONSOLE=layout:detailed,level:DEBUG

    Enable console logging at debug level, use detailed layout, and log internal framework events.

    Note: Internal events will be sent to the console to help diagnose issues within the logging framework.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.console.CONSOLE=layout:detailed,level:DEBUG -Dgreenhat.loginternal=console

    Disable all logging.

    When running the CICS® Transaction Gateway client application, edit the Java™ system properties as follows:

    -Dgreenhat.logappender.none
  2. Save your changes.
  3. Restart the CICS® Transaction Gateway client application as required.