Viewing the diagnostic log

If you are an HCL Quality Server administrator, you can view, download, and share the contents of the diagnostic log of HCL Quality Server. The diagnostic log provides information about the execution of the HCL OneTest™ Virtualization components. When enabled for a given proxy, this log records the same information as is contained in the log files that proxy writes to the disk, for example, information about how the HTTP proxy matches requests against the rules it has and whether it sends requests to a stub or to the live system. It might also include information about the execution of HCL Quality Server itself. You can view the diagnostic log on the server web UI.

About this task

HCL Quality Server is a central point of coordination among agents and proxies when stubs are running. To facilitate identifying and solving problems with HCL OneTest™ API proxies when they occur, the server can display a diagnostic log that is a centralized view of log events of those proxies.

Note: The HTTP/TCP proxy and the JDBC proxy are the only proxies that can be enabled for remote diagnostic logging to the server. By default, remote diagnostic logging is not enabled for either proxy, so you must enable it.

The diagnostic log can be exported to a comma-separated value (CSV) file, which can be shared with anyone who is not a HCL Quality Server user but who might be affected by, or be involved in supporting, the server or HCL OneTest™ Virtualization.

When the Diagnostic log page is first displayed, the most recent events are displayed first.

Procedure

  1. Log into the server.
  2. Click the Administration navigation link.

    Alternatively, click the Administration icon on the Home page.

    The Administration page is displayed.

  3. Click the Diagnostic log tab.

    The Diagnostic log tab is displayed.

    The columns on the tab are as follows:
    • Created (Time offset): The time offset indicates the difference between the time that a log message is sent and the time it has received in the server.
    • Source: The source type and host name are displayed, if available. If the source type and host name are not available, the universally unique identifier (UUID) of the source is displayed.
    • Logger: Activity log messages are displayed in the diagnostic log and are indicated by Activity Log under Logger
    • Message
    • Trace Data

    The following table describes how to use the controls on the tab:

    Table 1. Diagnostic log tab controls
    To: Do this:

    View individual pages of log entries.

    Click the Back and Forward buttons above Auto update to view the oldest and newest entries in large diagnostic logs.

    Enable or disable automatic updates of the log.

    Select or clear the Enable check box as required.

    Note: If you want analyze individual events in a large diagnostic log, disabling automatic updates may be helpful. To refresh the diagnostic log page after automatic updates have been disabled, re-enable automatic updates by selecting the Auto update check box.

    Save the currently displayed diagnostic log for archiving or sharing purposes.

    Under Export, click Download as CSV. Your web browser will prompt you to open or save the log export file.
    Note: If HCL Quality Server is not running, a backup of diagnostic log events is saved automatically as a CSV file in the HQS-Workspace\remoteLogs directory.

    Filter the display of log entries by date.

    1. Under Date range, click the From field to display a calendar pop-up window that enables you to select a start date.

    2. In the To list, click last entry: to filter the list up to the most recent log entry, or click date: to specify a specific end date.

    3. If you clicked date: in the To list, click the field under To to display a calendar pop-up window that enables you to select a an end date.

    Filter the display of log entries by log level.

    Under Level, click All values to display all log entries for all log levels, or click an individual log level to display log entries for only that log level.

    Note: To select more than one log level, hold CTRL or SHIFT while clicking each log level.

    Filter the display of log entries by log source-type.

    Under Source, click All values to display all log entries for all log source-types, or click an individual log source-type to display log entries for only that log source-type.

    Note: To select more than one log source-type, hold CTRL or SHIFT while clicking each source-type.
    Note: If an expected type is not displayed under Source, there are no log entries of that type.
Feedback