Skip to content

PCoIP Client Logging

The Software Client for Windows writes log files that document its processes and interactions with other services such as brokers and agents. These files are invaluale in diagnosing problems. This page describes how logs are handled and where they can be found.

Log Location

Client logs are placed in %localappdata%\Teradici\PCoIPClient\logs by default. Log locations can be overriden via launch configuration if required.

<Username> is the name of the user that launched the client.

Log Levels

Log verbosity is defined by a level, respresented by an integer from 0 to 4:

  • 0: Critical messages only
  • 1: Error messages and higher
  • 2: Info messages and higher (default)
  • 3: Debug messages and higher
  • 4: All messages (maximum verbosity)

The default setting is 2, recording informational messages and higher.

The log level can be changed in any of the following ways:

  • Via command-line launch: This method provides the log level inline during a command line launch; see Log Level in the configuration section for details.
  • Via the client UI:
    1. From the client's menu icon, click Settings.
    2. Set the log level as desired.
    3. Click Save.

Tip: Reporting issues to support

When you are reporting an issue to support, set the log level to 3 (debug) first, and then reproduce the issue and create a support bundle. This will capture much more detail than the default setting, making diagnostics more effective.

Log Session IDs

The Software Client for Windows creates a unique session ID when a new session is established, and distributes that ID to all components in the system. When PCoIP components generate log messages, they are prefixed by this unique session ID, allowing administrators and support to easily group events by session across multiple components:

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.

This session ID can be overridden by providing a custom string during a command line launch; see Log ID in the configuration section for details.