Client Logs¶

The Software Client for macOS 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¶

Software Client for macOS log files are located within the user’s Home Library folder, which is hidden by default. The recommended way to access Home Library files is to use the macOS Console.

You can also display log files in a macOS terminal window.

To display log files using the macOS Console:

1. To open the Console, go to the Applications > Utilities folder, and then double-click Console.
2. In the FILES section of the Log List pane on the left, navigate to the following folder: ~/Library/Logs/Teradici/PCoIPClient
3. Select the desired log file to view its contents in the main pane.
4. To copy the contents:
   • Click anywhere in the log contents, and then select Edit > Select All.
   • Select Edit > Copy.
   • Paste the contents into an email or text file.

To display log files in a macOS terminal window:

1. To open a terminal window, go to the Applications > Utilities folder, and then double-click Terminal.

2. Navigate to the Anyware Software Client log folder by typing the following command at the command line prompt:

   cd ~/Library/Logs/Teradici/PCoIPClient
   

3. Type ls to display the list of log files.

4. To view the contents of a log file, use any macOS command-line editor to open it.

Log Levels¶

Log verbosity is defined by a level, represented by an integer from 0 to 3:

The log level can be changed either from the pre-session interface, or programmatically from the Command Prompt.

Setting the Log Level in the Pre-session Interface¶

1. Disconnect active PCoIP sessions and return to the pre-session interface.

2. Click the gear icon to open the settings window.

   

3. Click Logs in the left pane.

4. Under Log level, specify the desired log level.

   

Setting the Log Level Programmatically¶

1. Launch the Software Client for macOS from the Command Prompt.

2. Include the log-level flag as a part of the command.

The following example launches the client in full-screen mode, sets the log level to 3, and points to a connection broker at broker.domain.com.

/usr/bin/pcoip_client --connection-broker  broker.domain.com --log-level 3 --full-screen