Enabling and disabling remote diagnostic logging for SIBus Intercept Mediator

To facilitate troubleshooting, HCL Quality Server administrators can view, download, and share detailed log events information for SIBus Intercept Mediator. The capability to display this information in HCL Quality Server requires enabling remote diagnostic logging for the agent.

About this task

HCL Quality Server can display a diagnostic log that is a centralized view of log events of agents and proxies.

By default, remote diagnostic logging to HCL Quality Server is not enabled in SIBus Intercept Mediator.

To enable or disable remote diagnostic logging for SIBus Intercept Mediator, you must add a new logging configuration to the SIBus Intercept Mediator enterprise application.

Procedure

  1. Open the Integrated Solutions Console of IBM® WebSphere® Application Server.
  2. Click Servers > Server Types > WebSphere application servers. In the Application Servers window, click the server name link.
  3. Under Server Infrastructure, expand Java and Process Management and click Process definition.
  4. Click Java Virtual Machine, and then click Custom properties.
  5. Enter the logging configuration as shown in the following table:
    Table 1. Custom properties for enabling and disabling remote diagnostic logging for SIBus Intercept Mediator to HCL Quality Server
    To: Do the following:

    Enable remote diagnostic logging at debug level to HCL Quality Server

    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.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.net.NET

      Value: level:DEBUG

    3. Click Apply, OK, and click New again.
    4. Under General Properties, enter the following:

      Name: greenhat.logappender.jul.JUL

      Value: level:DEBUG

    5. Click Apply and OK.

    Enable remote diagnostic logging at debug level to HCL Quality Server 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.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.net.NET

      Value: url:http://<IP address or host name>,level:DEBUG

    3. Click Apply, OK, and click New again.
    4. Under General Properties, enter the following:

      Name: greenhat.logappender.jul.JUL

      Value: level:DEBUG

    5. Click Apply and OK.

    Enable remote diagnostic logging at debug level and internal logging to HCL Quality Server.

    Note: Available levels are error, warning, info, debug, and trace.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.net.NET

      Value: level:DEBUG

    3. Click Apply, OK, and click New again.
    4. Under General Properties, enter the following:

      Name: greenhat.logappender.jul.JUL

      Value: level:DEBUG

    5. Click Apply, OK, and click New again.
    6. Under General Properties, enter the following:

      Name: greenhat.loginternal

      Value: appender

    7. Click Apply and OK.

    Enable remote diagnostic logging at error or warning level to HCL Quality Server.

    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.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.net.NET

      Value: level:WARNING

    3. Click Apply and OK.

    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.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.console.CONSOLE

      Value: layout:detailed,level:DEBUG

    3. Click Apply and OK.

    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.
    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.console.CONSOLE

      Value: layout:detailed,level:DEBUG

    3. Click Apply, OK, and clickNew again.
    4. Under General Properties, enter the following:

      Name: greenhat.loginternal

      Value: console

    5. Click Apply and OK.

    Disable all logging.

    1. Click New on the Custom properties page.
    2. Under General Properties, enter the following:

      Name: greenhat.logappender.none

      Value: NONE
      Note: You can enter any value in the Value field because it will be ignored.
    3. Click Apply and OK.
  6. In the Messages box, click Save.
  7. Start the SIBus Intercept Mediator enterprise application by completing the following tasks:
    1. In Applications > Application Types > WebSphere enterprise applications, select the check box next to greenhat.sibus.agent.
    2. Click Start.
      Note: You might have to stop the application before restarting it.
Feedback