Software Client for macOS Administrators' Guide

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 the log files folder is via Anyware Client, or in the Terminal app.

Displaying log files in the PCoIP Client

  1. Open the Anyware Client.

  2. In the top-left corner, click the gear icon.

  3. On the Anyware | Settings window, click logs.

  4. click Show in folder to display the logs in finder.

Displaying log files using the Terminal App

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

  2. Navigate to the log folder by running the following command:

    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:

Level Description
0 Critical messages only
1 Error messages and higher
2 Info messages and higher (default setting)
3 Debug messages and higher

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

Tip: Reporting Issues to Support

When reporting an issue to support, set the log level to 3 (debug), reproduce the issue, and then create a support bundle. This ensures that the required details are captured, making diagnostics more effective.

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 in the top-left corner to open the Anyware | 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. 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.

/Applications/PCoIPClient.app/Contents/MacOS/PCoIPClient --connection-broker  broker.domain.com --log-level 3 --fullscreen
Last updated: Thursday, July 18, 2024