Skip to content

Viewing and Managing Logs from the Management Console

HyWorks Controllers record Informative, Warning, and Error logs. These logs can be viewed from Logs > Logs.

The following information is displayed:

  • Log time: The time at which the log was generated or the activity occurred.

  • Source: Tracking the source of an action is crucial. When a client sends requests to the controller, logs are generated with the device’s IP address as the source. If the request comes from the session host server, the log will indicate the session host server as the source.

  • Username: The user who is starting the operation. (Administrator, user, or system).

  • Type: The log type, e.g., INFO, ERROR, WARNING.

  • Message: Please enter the message you would like to display.

  • Details: Log details (if applicable)).

UI Controls on the Logs Page

Once the administrator navigates to Logs > Logs, the administrator may attempt to customize the view for ease of log analysis using the following controls:

  1. Filter Logs

  2. Go to a specific page

  3. Control the Number of Logs to be displayed on one page

  4. Search Logs

Filter Logs

The following filtering options are available on the Logs page:

  • Filter by Log Type: Logs can be filtered by type.

    • All: View all logs

    • Error: View Error logs only

    • Warning: View Warning logs

    • Info: View Information logs only.

  • Filter by Date: Select the To and From dates to view logs for a specific period.

Search Logs

To view logs containing a specific text, search for that text in the logs. By default, it lists all logs matching the search results. To search logs matching complete strings with spaces, search text can be provided enclosed in double quotes. For example, to search an IP address, the following search text can be used: "192.168.1.100."

Go to Page

The logs are listed, with the most recent ones shown at the top. The administrator can choose a page to jump directly to a specific page number. The control is available in the bottom-left corner of the Logs page.

An alternative way to navigate to the next page is provided in the bottom right section of the Logs page, where administrators can click on the page number to jump directly to that page.

View Specific Number of Records on the Page

In the bottom center, a dropdown menu allows administrators to choose the number of records to be displayed on a page. The default is Auto, which means the best fit includes the Download Logs from All Organizations privilege and the available display area.

Download Logs

Follow the steps provided below to download the logs from the HyWorks Controller Management Console:

  1. Navigate to Logs page Logs > Logs.

  2. Click on Download Logs.

  3. Download Logs prompt will be shown:

    1. Choose From Date and To Date.

    2. Select File Format as CSV or TXT.

    3. Download Logs from The current organization or All Organizations. (This option is integrated with HyWorks v3.4-SP2 and will not be shown in older versions.)

    Note

    Users with the Super Administrator role or a custom role that includes the Download Logs from All Organizations privilege can select this option to download logs from all organizations.

    1. Click on Get Logs. Wait for log processing to be done.

    2. Once the logs are processed, a “Download Log File” button will appear; click on it to download the log file.

  4. The log file is downloaded in zipped format, named HyWorks-Controller-Log.zip.

  5. The downloaded file will have logs with the following details:

    1. Date: Timestamp of log.

    2. Source: The HyWorks node initiated this action.

    3. Organization Name: Name of the organization to which the log entry belongs. (This option is integrated into HyWorks v3.4-SP2 and will not be displayed in older versions.)

    4. Organization Code: The organization code to which the log belongs. (This option is integrated with HyWorks v3.4-SP2 and will not be shown in older versions.)

    5. Username: Action initiator. SystemUser means - HyWorks itself.

    6. Log Level: As in error, info, warning.

    7. Message: Error message.

    8. Details: Log entry details.

Important

While sharing logs for analysis, it is always encouraged to download logs of all organizations.