Performing Diagnostics¶
Each PCoIP component creates and updates a log file which records its activity as the system is used. Most troubleshooting within a PCoIP system begins by examining these log files and looking for error conditions or other indications that may explain why the system is not operating as expected.
Log files for the Graphics Agent for Linux and other Teradici PCoIP components are saved to specific directories.
Note: Bundling log files for support
When investigating issues with Teradici support, you may need to provide a support file which includes system log files. Instructions are provided here.
Locating Agent Log Files¶
Log files for the PCoIP agent are located in the following directories by default. If you changed your agent's location during installation, the log files will be in your custom location instead.
Component | Log file location |
---|---|
Agent | /var/log/pcoip-agent/agent.log |
Arbiter | /var/log/pcoip-agent/arbiter.log |
Session Launcher | /var/log/pcoip-agent/session-launcher.log |
Server/User | /var/log/pcoip-agent/server.<user>.log |
Note: Bundling log files for support
When investigating issues with Teradici support, you may need to provide a support file which includes system log files. Instructions are provided here.
Setting Log Verbosity¶
Each PCoIP component generates diagnostic log messages. The default log levels are recommended for use in a production deployment. When troubleshooting a particular problem, Teradici Support Services may recommend adjusting the PCoIP event log verbosity level to obtain more information from certain parts of the system.
Note: This is a global setting
The pcoip.event_filter_mode
directive is a global setting, and affects the output levels of all PCoIP components.
To change the log verbosity level, set the pcoip.event_filter_mode
directive in the pcoip-agent.conf file. See Configuring the PCoIP Agent for instructions.
Log rotation¶
Log files in Linux agents are managed by logrotate
. To manage how log files are rotated, edit the following files:
- /etc/logrotate.d/pcoip-*
- /usr/share/pcoip-agent/pcoip-server.logrotate
Session Log IDs¶
At the start of each PCoIP session, a unique session ID is generated by the PCoIP Client and passed to all connected PCoIP components (including the Graphics Agent for Linux). Log messages generated by the agent are prefixed with this session ID, making it easy to identify. All log messages generated during a single session, by any PCoIP component, will be prefixed with the same session log ID in RFC-4122 format:
yyyy-mm-ddThh:mm:ss.ffffffZ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx > …
For example:
2015-11-06T08:01:18.688879Z 4208fb66-e22a-11d1-a7d7-00a0c982c00d > …
Log messages that do not pertain to a specific session will show a string of zeroes in place of the session log ID number.
If a PCoIP component does not receive a session log ID from the PCoIP client, or receives an invalid value, it will generate a new session log ID and distribute it to the other components in the system.