Site Analytics

The Monitor dashboard provides a centralized location to monitor the health and usage of a Site.

Monitor dashboard

If there are currently no failures and no failures have occurred in the past 60 minutes, panels stay collapsed. When there are failures, the specific failure panel automatically appears.

Panel Description
User Connection Failures Connection failures over the last 60 minutes. Click the categories next to the total number to view metrics for that type of failure. In the adjacent table, that number is broken out by Delivery Groups. Connection failures includes failures caused by application limits being reached. For more information on application limits, see Applications.
Failed Single session OS Machines or Failed Multi-session OS Machines Total failures in the last 60 minutes broken out by Delivery Groups. Failures broken out by types, including failed to start, stuck on boot, and unregistered. For Multi-session OS machines, failures also include machines reaching maximum load.
Sessions Connected Connected sessions across all Delivery Groups for the last 60 minutes.
Average Logon Duration Logon data for the last 60 minutes. The large number on the left is the average logon duration across the hour. Logon data for VDAs earlier than XenDesktop 7.0 is not included in this average. For more information, see Diagnose user logon issues.

Note:

If no icon appears for a particular metric, this indicates that this metric is not supported by the type of host you are using. For example, no health information is available for System Center Virtual Machine Manager (SCVMM) hosts, AWS and CloudStack.

Continue to troubleshoot issues using these options (which are documented below):

Monitor sessions

If a session becomes disconnected, it is still active and its applications continue to run, but the user device is no longer communicating with the server.

Action Description
View a user’s currently connected machine or session From the Activity Manager and User Details views, view the user’s currently connected machine or session and a list of all machines and sessions to which this user has access. To access this list, click the session switcher icon in the user title bar. For more information, see Restore sessions.
View the total number of connected sessions across all Delivery Groups From the Dashboard, in the Sessions Connected pane, view the total number of connected sessions across all Delivery Groups for the last 60 minutes. Then click the large total number, which opens the Filters view, where you can display graphical session data based on selected Delivery Groups and ranges and usage across Delivery Groups.
End idle sessions The Sessions Filters view displays data related to all active sessions. Filter the sessions based on Associated User, Delivery Group, Session State, and Idle Time greater than a threshold time period. From the filtered list, select sessions to log off or disconnect. For more information, see Troubleshoot applications.
View data over a longer period of time On the Trends view, select the Sessions tab to drill down to more specific usage data for connected and disconnected sessions over a longer period of time (that is, session totals from earlier than the last 60 minutes). To view this information, click View historical trends.

Note:

If the user device is running a legacy Virtual Delivery Agent (VDA), such as a VDA earlier than version 7, or a Linux VDA, Monitor cannot display complete information about the session. Instead, it displays a message that the information is not available.

Desktop Assignment Rules limitation: Citrix Studio allows assignment of multiple Desktop Assignment Rules (DAR) for different users or user groups to a single VDA in the Delivery Group. StoreFront displays the assigned desktop with the corresponding Display Name as per the DAR for the logged in user. However, Monitor does not support DARs and displays the assigned desktop using the Delivery Group name regardless of the logged in user. As a result, you cannot map a specific desktop to a machine in Monitor. You can map the assigned desktop displayed in StoreFront to the Delivery Group name displayed in Monitor using the following PowerShell command. Run the PowerShell command using Remote PowerShell SDK as described in the blog.

Get-BrokerDesktopGroup | Where-Object { $\_.Uid -eq (Get-BrokerAssignmentPolicyRule | Where-Object { $\_.PublishedName -eq "\<Name on StoreFront\>" }).DesktopGroupUid } | Select-Object -Property Name, Uid

Disable the visibility of running applications in the Activity Manager

By default, the Activity Manager displays a list of all running applications for a user’s session. This information can be viewed by all administrators that have access to the Activity Manager feature . For Delegated Administrator roles, this includes Full Administrator, Delivery Group Administrator, and Help Desk Administrator.

To protect the privacy of users and the applications they are running, you can disable the Applications tab to list running applications. To do this, on the VDA, modify the registry key located at HKEY_LOCAL_MACHINE\Software\Citrix\Director\TaskManagerDataDisplayed. By default, the key is set to 1. Change the value to 0, which means the information is not collected from the VDA and hence not displayed in the Activity Manager.

Warning:

Editing the registry incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Session transport protocol

View the transport protocol in use for the HDX connection type for the current session in the Session Details panel. This information is available for sessions launched on VDAs Version 7.13 or later.

Transport protocol

  • For HDX Connection type,
    • The Protocol is displayed as UDP, if EDT is used for the HDX connection.
    • The Protocol is displayed as TCP, if TCP is used for the HDX connection.
  • For RDP Connection type, the Protocol is displayed as n/a.

When adaptive transport is configured, the session transport protocol dynamically switches between EDT (over UDP) and TCP, based on the network conditions. If the HDX session cannot be established using EDT, it falls back to the TCP protocol.

For more information about adaptive transport configuration, see Adaptive Transport.

Export reports

You can export trends data to generate regular usage and capacity management reports. Export supports PDF, Excel, and CSV report formats. Reports in PDF and Excel formats contain trends represented as graphs and tables. CSV format reports contain tabular data that can be processed to generate views or can be archived.

To export a report:

  1. Go to the Trends tab.
  2. Set filter criteria and time period and click Apply. The trend graph and table are populated with data.
  3. Click Export and enter name and format of the report.

Monitor generates the report based on the filter criteria you select. If you change the filter criteria, click Apply before you click Export.

Note:

Export of a large amount of data causes a significant increase in memory and CPU consumption on the Monitor server, the Delivery Controller, and the SQL servers. The supported number of concurrent export operations and the amount of data that can be exported is set to default limits to achieve optimal export performance.

Supported export limits

Exported PDF and Excel reports contain complete graphical charts for the selected filter criteria. However, tabular data in all report formats is truncated beyond the default limits on the number of rows or records in the table. The default number of records supported is defined based on the report format.

Report format Default number of records supported
PDF 500
Excel 100,000
CSV 100,000 (10,000,000 in Sessions tab)

Error Handling

Errors that you might encounter during an Export operation:

  • Director has timed out: This error could occur due to network issues or high resource usage on the Director server or with the Monitor Service.

  • Monitor has timed out: This error could occur due to network issues or high resource usage with the Monitor Service or on the SQL server.

  • Max concurrent Export or Preview operations ongoing: Only one instance of Export or Preview can run at a specific time. If you get the Max concurrent Export or Preview operations ongoing error, try the next operation again later.

Monitor hotfixes

To view the hotfixes installed on a specific machine VDA (physical or VM), choose the Machine Details view.

Control user machine power states

To control the state of the machines that you select in Monitor, use the Power Control options. These options are available for Single session OS machines, but might not be available for Multi-session OS machines.

Note:

This functionality is not available for physical machines or machines using Remote PC Access.

Command Function
Restart Performs an orderly (soft) shutdown of the VM and all running processes are halted individually before restarting the VM. For example, select machines that appear in Monitor as “failed to start,” and use this command to restart them.
Force Restart Restarts the VM without first performing any shut-down procedure. This command works in the same way as unplugging a physical server and then plugging it back in and turning it back on.
Shut Down Performs an orderly (soft) shutdown of the VM; all running processes are halted individually.
Force Shutdown Shuts down the VM without first performing any shut-down procedure. This command works in the same way as unplugging a physical server. It might not always shut down all running processes, and you risk losing data if you shut down a VM in this way.
Suspend Suspends a running VM in its current state and stores that state in a file on the default storage repository. This option allows you to shut down the VM’s host server and later, after rebooting it, resume the VM, returning it to its original running state.
Resume Resumes a suspended VM and restores its original running state.
Start Starts a VM when it is off (also called a cold start).

If power control actions fail, hover the mouse over the alert, and a pop-up message appears with details about the failure.

Prevent connections to machines

Use maintenance mode to prevent new connections temporarily while the appropriate administrator performs maintenance tasks on the image.

When you enable maintenance mode on machines, no new connections are allowed until you disable it. If users are currently logged on, maintenance mode takes effect as soon as all users are logged off. For users who do not log off, send a message informing them that machines will be shut down at a certain time, and use the power controls to force the machines to shut down.

  1. Select the machine, such as from the User Details view, or a group of machines in the Filters view.
  2. Select Maintenance Mode, and turn on the option.

If a user tries to connect to an assigned desktop while it is in maintenance mode, a message appears indicating that the desktop is currently unavailable. No new connections can be made until you disable maintenance mode.

Application Analytics

The Applications tab displays application-based analytics in a single, consolidated view to help analyze and manage application performance efficiently. You can gain valuable insight into the health and usage information of all applications published on the Site. It shows metrics such as the probe results, number of instances per application, and faults and errors associated with the published applications. For more information, see the Application Analytics section in Troubleshooting Applications.