PCoIP Connection Manager and Security Gateway Log Files¶
Each PCoIP component logs its activities and stores the log files locally. Troubleshooting behavior problems usually begins with an examination of PCoIP log files for error conditions or other system health indicators.
All PCoIP components use an identical, session-specific ID in their respective log files, allowing you to separate individual sessions and aggregate messages from multiple components within a session. The session ID is a 36-character hexadecimal string.
Warning: Maintain your 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.
Logging Specifications¶
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 | Daily at midnight local time or when log file reaches maximum size |
Log file encryption | No | No |
Pre-session logs | Yes | Yes |
In-session logs | No1 | Yes |
Sensitive Information in Logs¶
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 File Locations¶
PCoIP Connection Manager Log File Locations¶
The default log directory for the PCoIP Connection Manager is /var/log/Teradici/ConnectionManager/. The following log files are stored in this location:
Type | Filename |
---|---|
Current PCoIP Connection Manager log file | pcoip-connmgr_<timestamp>.log |
Archived PCoIP Connection Manager log files | pcoip-connmgr_<timestamp>.log.gz |
Tomcat log file | catalina.log |
For example, the default filepath of the current PCoIP Connection Manager log file is /var/log/Teradici/ConnectionManager/pcoip-connmgr_<timestamp>.log.
PCoIP Security Gateway Log File Locations¶
The default log directory for the PCoIP Security Gateway is /var/log/Teradici/SecurityGateway/. Only PCoIP Security Gateway logs are stored in this location:
Type | Filename |
---|---|
All log files | SecurityGateway_<timestamp>.log |
The current log file for the PCoIP Security Gateway is the file at /var/log/Teradici/SecurityGateway/SecurityGateway_<timestamp>.log with the most recent timestamp.
Log Verbosity¶
PCoIP logs can capture log messages at several different verbosity levels, ranging from highly verbose informational messages to error-only reporting. The verbosity of logs in both the PCoIP Connection Manager and PCoIP Security Gateway can be customized by setting the LogLevel
value in their respective conf files.
Teradici recommends using the default verbosity log level in production deployments. When troubleshooting a problem, Teradici might recommend changing the log level for specific components to obtain more information from parts of the system.
Changing the PCoIP Connection Manager Log Level¶
To configure the log level of the PCoIP Connection Manager:
-
Edit the PCoIP Connection Manager configuration file
/etc/ConnectionManager.conf
. -
Find and modify the
LogLevel
value:LogLevel = <log level value>
Where
<log level value>
is one ofTRACE
,DEBUG
,INFO
,WARN
, orERROR
. -
Restart the PCoIP Connection Manager to apply changes:
service connection_manager restart
Changing the PCoIP Security Gateway Log Level¶
PCoIP Security Gateway log levels are numeric, and correspond to the same log levels used in the PCoIP Connection Manager. The levels are:
0
: TRACE1
: DEBUG2
: INFO3
: WARN4
: ERROR
To configure the log level of the PCoIP Security Gateway:
-
Edit the PCoIP Connection Manager configuration file
/etc/SecurityGateway.conf
. -
Find and modify the
LogLevel
value:LogLevel = <log level value>
Where
<log level value>
is one of0
,1
,2
,3
, or4
. -
Restart the PCoIP Connection Manager to apply changes:
service security_gateway restart
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.
-
The PCoIP Connection Manager is only active during the pre-session phase. ↩