PCoIP Connection Manager and Security Gateway Log Files

Each PCoIP component logs its activities. Troubleshooting usually begins with checking PCoIP log files for error conditions or other indicators that show why the system may not be operating as expected.

Each PCoIP component is configured to log at a particular verbosity level and Teradici recommends using the default log level in a production deployment. The LogLevel setting in each component’s configuration file controls the quantity and type of log messages written to the log file.

To assist with troubleshooting, all PCoIP components use the same 36-character hexadecimal string in the log files to correlate different components for a specific session.

When troubleshooting a problem, Teradici might recommend changing the log level for specific components to obtain more information from parts of the system.

Sensitive information such as passwords, session cookies, and other session data that can potentially be used to gain unauthorized access is either obscured or not logged. Non-sensitive, unique session identifiers such as user names and IP addresses are logged as these often help with troubleshooting.

Log files have these parameters:

 

PCoIP Connection Manager

PCoIP Security Gateway

Maximum log file size

25 MB

2 MB

Maximum number of log files

100

Unlimited

Old log files

Compressed

Not compressed

Log file rotation

Daily at midnight local time or when log file reaches maximum size

Log file encryption

No

  Warning: Maintain log files
The PCoIP Connection Manager and the PCoIP Security Gateway do not monitor available disk space. To prevent service disruptions caused by a full hard drive, periodically delete old log files.

For a complete list of settings that can be configured, see PCoIP Connection Manager Configuration Settings and Administering the PCoIP Security Gateway.

Log File Default Location

Logs for components are required for troubleshooting depending on whether error conditions happen before the PCoIP session (pre-session) or during the session (in-session).

All log files are named with a timestamp suffix; the current log file for each component has the most recent timestamp.

See the default locations of the log files in the following table.

Component

Log File Default Location

Pre-Session

In-Session

PCoIP Connection Manager

/var/log/Teradici/ConnectionManager/pcoip-connmgr_timestamp.log

 

PCoIP Security Gateway

/var/log/Teradici/SecurityGateway/SecurityGateway_timestamp.log

The PCoIP Connection Manager default log file location includes:

Log Level Configuration

This topic shows how to change the log level for the PCoIP Connection Manager and PCoIP Security Gateway.

PCoIP Connection Manager Log Level Configuration

Log levels are TRACE, DEBUG, INFO, WARN, ERROR.

To configure the log level of the PCoIP Connection Manager:

  1. Edit the PCoIP Connection Manager configuration file /etc/ConnectionManager.conf.
  2. Change LogLevel = TRACE/DEBUG/INFO/WARN/ERROR.
  3. Restart the PCoIP Connection Manager to apply changes.

PCoIP Security Gateway Log Level Configuration

Log levels are 0: TRACE, 1: DEBUG, 2: INFO, 3: WARN, 4: ERROR.

To configure the log level of the PCoIP Security Gateway:

  1. Edit the PCoIP Security Gateway configuration file /etc/SecurityGateway.conf.
  2. Change LogLevel = 0/1/2/3/4.
  3. Restart the PCoIP Security Gateway .
  Caution: Periodically delete old log files

When you set the log level to trace or debug, the system may create a large volume of logs. To prevent service disruptions caused by a full hard drive, periodically delete old log files.

© 2017 Teradici Corporation. All rights reserved. TER1502010/B