Using DCT to Collect Logs for Remote Desktop Features and Components

You can set log levels and generate log files in a Data Collection Tool (DCT) bundle for a specific remote desktop feature, or all remote desktop features, on a Horizon Agent for Windows, Horizon Client for Linux, Horizon Client for Mac, or Horizon Client for Linux system.

Default Installation Paths

The DCT scripts are installed in the following directories and run from the agent and client installation paths.

• Horizon Agent for Windows: C:\Program Files\VMware\VMware View\Agent\DCT\support.bat
• Horizon Agent for Linux: /usr/lib/vmware/viewagent/bin/dct-debug.sh
• Horizon Client for Windows: C:\Program Files (x86)\VMware\VMware Horizon View Client\DCT\support.bat
• Horizon Client for Mac: /Applications/VMware Horizon Client.app/Contents/Library/dct/HorizonCollector.sh
• Horizon Client for Linux: /usr/bin/vmware-view-log-collector

Command Syntax

Use the following commands to run the DCT script for each platform.

• Horizon Agent for Windows: support.bat
• Horizon Agent for Linux: dct-debug.sh
• Horizon Client for Windows: support.bat
• Horizon Client for Mac: HorizonCollector.sh
• Horizon Client for Linux: vmware-view-log-collector

Supported Features

The remote desktop features listed in the following table have JSON configuration files that contain log level settings, log collection settings, and dump collection settings.

These services are available on Horizon Agent for Windows, Horizon Agent for Linux, Horizon Client for Windows, Horizon Client for Mac, and Horizon Client for Linux systems, with certain exceptions as noted.

For command-line options that accept feature names, specify the name shown in the Feature Name column.

Feature Name	Full Feature Name	Default Log Level
AgentCore	Agent Core Note: This service is only available for Horizon Agent for Windows and Horizon Agent for Linux.	DEBUG
Appscanner	App Scanner	INFO
Blast	Blast Note: This service is only available for Horizon Agent for Windows and Horizon Agent for Linux.	INFO
Blastserver	Blast Server Proxy Note: This service is only available for Horizon Agent for Linux.	INFO
Client	Client Note: This service is not available for Horizon Agent for Windows or Horizon Agent for Linux.	INFO
CDR	Client Drive Redirection	INFO
Clipboard	Clipboard Redirection	INFO
Collabui	Collaboration UI Note: This service is only available for Horizon Agent for Linux.	INFO
Desktopdaemon	Desktop Daemon Controller Note: This service is only available for Horizon Agent for Linux.	INFO
DPISync	DPI Synchronization	INFO
DnD	Drag and Drop Note: This service is not available for Horizon Agent for Linux or Horizon Client for Linux.	INFO
FA	File Type Association Note: This service is not available for Horizon Agent for Linux or Horizon Client for Linux.	DEBUG
Helpdesk	HelpDesk Note: This service is only available for Horizon Agent for Linux.	INFO
TSMMR	Multimedia Redirection Note: This service is not available for Horizon Agent for Linux or Horizon Client for Mac.	INFO
PCoIP	PCoIP	INFO
PerfTracker	Performance Tracker Note: This service is only available for Windows Agent.	INFO
PrintRedir	Printer Redirection	INFO
PublishedApp	Published Applications Note: This service is not available for Horizon Agent for Linux.	INFO
Rdesvc	RDE Service Note: This service is only available for Horizon Agent for Linux.	INFO
RTAV	RTAV	DEBUG
ScannerRedirection	Scanner Redirection Note: This service is not available for Horizon Agent for Linux or Horizon Client for Mac.	INFO
SerialPortRedirection	Serial Port Redirection Note: This service is not available for Horizon Agent for Linux or Horizon Client for Mac.	INFO
SmartCard	Smart Card Redirection Note: This service is not available for Horizon Client for Windows.	INFO
Truesso	True SSO Note: This service is only available for Horizon Agent for Linux.	DISABLED
URLRedirection	URL Content Redirection Note: This service is not available for Horizon Agent for Linux.	INFO
USB	USB Redirection	DEBUG Note: For Horizon Agent for Linux, default is INFO.
VDPService	VDPService	INFO
Watermark	Digital Watermark	INFO

Command-Line Options

The following table describes the command-line options and usage.

Option	Usage	Description
-l	-l	Lists log levels for all the features and components that DCT supports. For example, the output of the Horizon Client for Windows command support.bat -l lists all the components that DCT controls and the log level status: - Agent Core [INFO] - PCoIP [INFO] - Virtual Channel [INFO] - VDP Service [TRACE] - Remote Features - Client Drive Redirection [TRACE] - Clipboard Redirection [DEBUG] - Drag and Drop [TRACE] - DPI Synchronization [INFO] - File Type Association [INFO]
	-l feature1,feature2 ...	Lists log levels for the specified features. For example, the output of the Horizon Client for Windows command support.bat -l CDR,DnD lists the log level status for the Client Drive Redirection and Drag and Drop features: - Client Drive Redirection [TRACE] - Drag and Drop [TRACE]
	-l -dumps	Queries the dump settings for the configured processes. For example, the output of the Horizon Client for Windows command support.bat -l -dumps lists the name, dump type, and maximum dump count for each process: Process Name Dump Type Max Dump Count ======================================================== vmware-view.exe Full 128 vmware-remotemks.exe Full 128 vmware-appstub.exe Full 128 horizon_client_service.exe Full NO LIMIT Note: This command is available only for Horizon Client for Windows.
	-l -dumps count	Queries the dump count for the configured processes. Note: This command is available only for Horizon Client for Windows.
	-l -dumps type	Queries the dump type for the configured processes. Note: This command is available only for Horizon Client for Windows.
-ld	-ld feature1,feature2 ...	Lists log level details for the specified features.
-x	-x All:level	Sets the log level for all the features that DCT supports. Valid log levels are as follows: Info Debug Trace Verbose
	-x feature1:level1,feature2:level2 ...	Sets the log level for the specified features or components. For example, the Horizon Client for Linux command vmware-view-log-collector -x All:TRACE sets the log level to Trace for all components. The Horizon Client for Linux command vmware-view-log-collect -x DnD:INFO,CDR:TRACE sets the log level for the Drag and Drop feature to Info and the log level for the Client Drive Redirection feature to Trace.
-r	-r	Resets the log levels of all features to the installation defaults.
-c	-c All	Collects all logs.
	-c feature1,feature2 ...	Collects logs for the specified features or components.
-d	-d directory1	Redirects DCT output to the specified directory.
-f	-f bundleName	Specifies the full name of the log bundle file to bundleName.
-h	-h	Displays help information for command-line options and lists supported features and components for DCT.
-del	-del -dumps All	Deletes the dumps for all the features and components that DCT supports. Note: This command is available only for Horizon Client for Windows.
	-del -dumps feature1,feature2 ...	Deletes the dumps for the specified features. For example, the output of the Horizon Client for Windows command support.bat -del -dumps Client,FA deletes the dump files for the Client and File Type Association features. Note: This command is available only for Horizon Client for Windows.

Real-Time Dump

For Horizon Client for Windows and Horizon Agent for Windows, real-time dump is also supported for some features. This function dumps the target process based on the configuration file setting and collects the dump in the log bundle. Whether a real-time dump needs to be generated depends on the feature's configuration.

For example, if you run the command support.bat -c for Horizon Client for Windows, the message You can choose to generate diagnostic dumps of the VMware Horizon Client processes running on this machine, please note these files can be very large appears. If you choose Y, dump files are generated for existing processes related to Horizon Client for Windows.