Performing Logging Tasks¶
Enabling the Event Log allows you to configure diagnostic logging tasks such as:
-
Enabling and configuring Syslog as the logging protocol to use to collect and report events. Additional information on Syslog can be found in Configuring Syslog.
-
Enabling enhanced logging mode for specific components, such as USB or video components.
Providing Event Log Files to Support
Log files from an endpoint are captured by simply highlighting the event log, then copy and pasting the entries to a text file.
Enabling the Event Log¶
The following steps will allow you to view and obtain the necessary log entries to troubleshoot any issues with your endpoint.
-
From the AWI, browse to Diagnostics > Event Log and ensure the Enable Event Log check box is selected.
AWI Event Log page -
Select any of the following actions.
-
Select the View button to display event log messages stored on the endpoint using the F5 to refresh the browser page displaying the log information.
-
Select the Clear button to delete all the event log messages stored on the endpoint and start logging events from a time of your choosing.
-
If you require enhanced logging details to help troubleshoot a specific type of problem with a Tera2 PCoIP endpoint, select an enhanced logging category and click Apply > Continue. See the event log parameters table below for further descriptions of each enhanced log parameter.
To return to normal logging mode, click Disable and then Apply > Continue.
Enhanced Settings
-
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.
-
-
The following parameters display on the AWI Event Log page.
Disabling the Event Log¶
You can disable the event log using the AWI and deselecting the Enable Event Log option which disables the event log and removes syslog and enhanced logging options from view.
AWI - Disabled Event Log
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 in the AWI and OSD, deletes existing persistent event logs, and stops verbose messages being sent to configured syslog server. |
| Event Log Messages |
|
| 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). The configurable parameter that displays depends on which option you choose to identify the syslog server host.
If Syslog Connection Type is TCP with TLS the uploaded public certificate for the syslog server must have the common name match the value defined here (either IP address or FQDN). |
| Syslog Host Port | Enter the port number of the syslog server. The default port number value is 514 for UDP, See IANA Syslog Ports. |
| 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:
|
| Syslog Enable Metadata | When enabled, each syslog message will prefix the message with the PCoIP Device Name and the Generic Tag. When disabled, the metadata will be omitted. |
| Syslog Connection Type |
|
| Client Certificate | Required for secure TCP with TLS connection types that require Mutual Authentication of both server and client. Use this to select the client certificate from the endpoint certificate store. Note a client certificate must be uploaded to the certificate store prior to selection and must contain both the private key and public certificate information. See (Upload Certificate - reference) |
| Enhanced logging mode | Enhanced logging mode categories:
|