Enabling and disabling remote diagnostic logging for the Java™ virtualization agent

To facilitate troubleshooting, HCL® Quality Server administrators can view, download, and share detailed log events information for the Java™ virtualization agent. 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.

By default, remote diagnostic logging to HCL® Quality Server is not enabled in the Java™ virtualization agent.

To enable or disable remote diagnostic logging for the Java™ virtualization agent, you must modify the startup parameters of the application that you want to record or virtualize.

Procedure

  1. Edit the startup parameters as shown in the following table:
    Table 1. Parameters for enabling and disabling remote diagnostic logging for the Java™ virtualization agent 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.

    Edit the invocation command line or the system properties within the Java™ application as follows:

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

    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.

    Edit the invocation command line or the system properties within the Java™ application 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 HCL® Quality Server.

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

    Edit the invocation command line or the system properties within the Java™ application 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 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.

    Edit the invocation command line or the system properties within the Java™ application 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.

    Edit the invocation command line or the system properties within the Java™ application 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.

    Edit the invocation command line or the system properties within the Java™ application as follows:

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

    Disable all logging.

    Edit the invocation command line or the system properties within the Java™ application as follows:

    -Dgreenhat.logappender.none

  2. Save your changes.
  3. Restart the application as required.