Performing Logging Tasks

Setting Default AWI OSD Management Console
Refresh (a button)
Refresh (F5)
Clear (a button)
Enable Event Log Enabled
Enable Syslog Enabled
Enable Syslog Host By IP Address
Syslog Host IP Address
Syslog Host Port 514
Syslog Facility 19 – local use 3
Enhanced logging mode Disabled

From the OSD and AWI, you can view and clear all the event log messages stored on your Tera2 PCoIP Zero Client.

From the AWI, you can perform additional logging tasks, including:

  • Enabling or disabling logging.
  • Enabling and configuring syslog as the logging protocol to use to collect and report events. (For more information about configuring syslog, see Configuring the Event Log and Syslog.)
  • Enabling enhanced logging mode for specific components, such as USB or video components.

Performing Logging Tasks from the OSD

The OSD Event Log page, as shown next, enables you to view, refresh, and clear event log messages.

Alt text
OSD Event Log page

To view or clear event log messages:

  1. From the OSD, select Options > Diagnostics > Event Log.
  2. From the OSD Event Log page, you can:
    1. View all the event log messages stored on the Tera2 PCoIP Zero Client.
    2. Click Refresh to refresh the log information displayed on the page.
    3. Click Clear to delete all the event log messages stored on the Tera2 PCoIP Zero Client.
    4. Click Close.

Performing Logging Tasks from the AWI

The AWI Event Log page, as shown next, enables you to enable or disable logging, view and clear event log messages, and set the log filtering mode. You can also enable and configure syslog as the logging protocol to use to collect and report events.

Alt text
AWI Event Log page

The following parameters display on the AWI Event Log page.

AWI Event Log Parameters

Parameter Description
Enable Event Log When this feature is enabled, logging occurs in verbose mode, and all event log and syslog options display.

When this feature is disabled, the logging options are hidden. Disabling the event log disables logging and deletes existing persistent event logs. If you configure syslog settings, logs won't be sent to a syslog server.
Event log Messages
  • View: Click to open a browser page that displays the event log messages (with timestamp information) stored on the device. Press F5 to refresh the browser page log information.
  • Clear: Click to delete all event log messages stored on the device.
Enable Syslog Enable or disable the syslog standard as the logging mechanism for the device.

Note: If you enable syslog, you must configure the remaining fields. If you disable syslog, you can't edit the fields.
Identify Syslog Host By Choose if the syslog server host is identified by its IP address or by its Fully Qualified Domain Name (FQDN).
Syslog Host IP Address / Syslog Host DNS name The parameter that displays depends on which option you choose to identify the syslog server host:
  • IP Address: Enter the IP address for the syslog server host.
  • FQDN: Enter the DNS name for the syslog server host.
If you enter an invalid IP address or DNS name, a message appears to prompt you to correct it.
Syslog Host Port Enter the port number of the syslog server. The default port number value is 514.
Syslog Facility The facility is a number attached to every syslog message. The number categorizes the source of the syslog messages. The facility is part of the standard syslog header and all syslog servers can interpret it.

Enter a facility to suit your logging needs. For example, you could configure devices as follows:
  • Zero clients to use facility 19
  • Cisco routers to use facility 20
  • VMware ESX hosts to use facility 21
The default facility is set to '19 – local use 3'. Cisco routers default to '23 – local use 7'.
Enhanced logging mode If you require enhanced logging details in the event log to help troubleshoot a problem with a Tera2 PCoIP Zero Client or PCoIP Remote Workstation Card, select an enhanced logging category, and click Apply > Continue. (To return to normal logging mode, click Disable, and then Apply > Continue.)

Enhanced logging may be enabled for only one category at a time.
Enhanced logging mode messages can be located in the event log by their Level 3 (LVL:3) designation, which indicates a debug-level message.

Enhanced logging mode categories:
  • Audio: Provides enhanced audio-related details, such as audio compression levels and audio bandwidth. Enable this mode if you are experiencing any problems with audio quality.
  • Management Console: Provides debug-level details for the connection state between the device and the MC. Enable this mode if you are having trouble connecting to or managing the device using the MC.
  • Networking: Provides socket-level details for a device’s network connections. Enable this mode for network-related issues—for example, if the device cannot connect to a peer or broker, or if it cannot get an IP address from a DHCP server.
  • OneSign: Provides enhanced logging for connections using Imprivata’s OneSign Single Sign-On proximity cards. Enable this mode to see debug-level messages between a device and a OneSign authentication server.
  • Session Negotiation: Provides pre-session messaging details, such as the full feature set advertised by each device. Enable this mode for low-level session negotiation details.
  • SmartCard: Provides debug-level messages for smart cards. Enable this mode if you experience trouble tapping or logging in using a smart card.
  • System: Provides heartbeat details about the device, such as ambient temperature. Enable this mode for system-level problems.
  • USB: Provides details of the traffic between the device and any connected USB devices. Enable this mode if you are experiencing problems with a connected USB device.
  • Video: Displays enhanced image-related logging information. Enable this mode for image problems, monitor problems, or display topology issues.

To perform Event Log tasks from the AWI:

  1. From the AWI, select Diagnostics > Event Log.

  2. From the AWI Event Log page, you can:

    • Select or clear the Enable Event Log check box.
    • View all the event log messages stored on the Tera2 PCoIP Zero Client.
    • Press F5 to refresh the browser page displaying the log information.
    • Click Clear to delete all the event log messages stored on the Tera2 PCoIP Zero Client.

    • In the Syslog section, enable and configure syslog settings.

      More information on configuring syslog

      For detailed instructions on configuring syslog settings, see Configuring the Event Log and Syslog.

    • In the Enhanced Logging Mode section, enable specific enhanced logging mode categories.

  3. Click Apply.