Dynatrace Hub

Extend the platform,
empower your team.

Popular searches:

Home hero bg

Citrix Virtual Apps and Desktops

Gain insight into your Citrix Virtual Apps and Desktops environments

Extension by Dynatrace

Citrix Dashboard

Desktop Properties

Citrix Waterfall

Product information
Release notes

Overview

The Citrix Virtual Apps and Desktops extensions allows you to monitor your Citrix environment.

You can choose to have a holistic view of your Citrix environment, monitor individual Virtual Delivery Agent machines or both.

The extension can be deployed in two different forms:

Citrix VDA - Monitor the individual user sessions, by activating the extension on each Virtual Delivery Agent
Citrix Powershell SDK - Monitor the entire Citrix Environment, by activating the extension on a machine that has the Citrix Powershell SDK installed. Usually where Citrix Studio is installed or a Delivery Controller.

Get Started - VDA

VDA - Virtual Delivery Agent

This mode captures Real User Monitoring data from the individual VDAs. Some Windows Performance Counters are also collected.

In this scenario, you must have an OneAgent deployed to each VDA. The recommmended activation flow for this scenario is:

Install the OneAgent on the Golden (or Master) Image
Make sure to set the Host ID source, the option most customers use is fqdn
Activate the Citrix Extension on that machine, by creating a Monitoring Configuration in your Dynatrace environment that targets that host and selecting the Citrix VDA monitoring mode
- This will distribute the extension binary to that machine, making the deployment much faster later since the extension binary will be available on all VDAs created by this machine.

Requirements

Ctrix Virtual Apps and Desktops (any version) or Citrix XenApp/XenDesktop (version 7.5 or later)
Your Citrix VDAs must have the Citrix End User Experience Monitoring service enabled and running

You can check that a certain VDA can be monitored by the extension by:

Starting a ICA Session on that VDA via the Citrix Receiver (Desktop or individual Application works)
Running these powershell commands on the VDA:
- Get-WmiObject -Class Citrix_Euem_RoundTrip -Namespace root\citrix\euem
- Get-WmiObject -Class Citrix_Sessions -Namespace root\citrix\hdx

These commands must return some data about the user session.

Activation

Create a new Custom Application

Navigate to Deploy Dynatrace > Monitor a custom application
Give your application a descriptive name, chose an icon, then select Monitor custom application.
Select Instrumentation wizard and keep a note of the Application ID that is generated for your custom application.

Create a Monitoring Configuration

Under Infrastructure -> Extensions chose Citrix Virtual Apps and Desktops and click Create monitoring configuration
Select which hosts you want to monitor, these are your Citrix VDAs.
- We highly recommend you make use of Host Groups, Management Zones or Tags to make this easier to manage. For example all VDAs of a farm could have their own Host Group
Monitoring Mode: Citrix VDA
Custom Application ID: The ID of the custom application you created in the previous step
Capture User Data: whether to capture Usernames and IP Addresses or not

After a couple minutes, if ICA Sessions are running on these VDAs you should see data being captured in the Custom Application you created.

Get Started - Powershell SDK

Citrix Powershell SDK

This mode captures metrics about your entire Citrix Environment using the Citrix Powershell SDK
In this mode the extension runs from a single machine where Citrix Studio (or the Powershell SDK) is installed.

Requirements

Citrix Virtual Apps and Desktops (any version) or Citrix XenApp/XenDesktop (version 7.5 or later)
The machine where the extension is running must have the Citrix Powershell SDK installed, this can be accomplished by installing Citrix Studio

To test that a machine can run this mode, execute commands below on powershell (as a user that can run Citrix Studio):

# replace localhost with the address of your delivery controller if necessary
Add-PSSnapin Citrix.*.Admin.V*
Get-BrokerSite -AdminAddress localhost

Activation

Under Infrastructure -> Extensions chose Citrix Virtual Apps and Desktops and click Create monitoring configuration
Select which host you want the extension to run from, the one where the Powershell SDK is available
Monitoring Mode: Citrix Powershell SDK
Username: an user that can run the citrix powershell sdk commands, it can include a domain example: my.company\my.user
Password: for the user defined above
Metric collection frequency: how often metrics should collect data

After a couple of minutes, metrics should be ingested for your Citrix environment. You can use the built in dashboard to access these metrics

Support

Built and supported by Dynatrace

Dynatrace support center

Subscribe to new releases

copy to clipboard

Extension content

Content typeNumber of items included

screen properties

1

metric metadata

35

screen entities lists

12

screen layout

5

list screen layout

5

screen chart groups

5

dashboards

1

generic type

5

generic relationship

9

screen logs cards

5

Feature sets

Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual metrics can be activated and deactivated by your administrator during configuration.

Feature setsNumber of metrics included

Metric name	Metric key	Description	Unit
Session State	citrix.broker_desktop.session_state	Gets machines with a specific session state. Valid values are null, Other, PreparingSession, Connected, Active, Disconnected, Reconnecting, NonBrokeredSession, and Unknown. Session properties are always null for multi-session machines.	State
Power State	citrix.broker_desktop.power_state	Gets machines with a specific power state. Valid values are Unmanaged (1), Unknown (2), Unavailable (3), Off (4), On (5), Suspended (6), TurningOn (7), TurningOff (8), Suspending (9), and Resuming (10).	State
Registration State	citrix.broker_desktop.registration_state	"Gets machines in a specific registration state. Valid values are Unregistered (1), Initializing (2), Registered (3), and AgentError (4).	State
Summary State	citrix.broker_desktop.summary_state	"Indicates the overall state of the desktop associated with the machine. The overall state is a result of other more specific states such as session state, registration state and power state. Possible values: Off (1), Unregistered (2), Available (3), Disconnected (4), InUse (5), Preparing (6).	State
In Maintenance Mode	citrix.broker_desktop.in_maintenance_mode	Denotes if the machine is in maintenance mode.	State
Sessions	citrix.broker_desktop.sessions	Count of number of sessions on the machine.	Count
Fault State	citrix.broker_desktop.fault_state	"Summary state of any current fault state of the machine. Can be one of the following: (1) None - No fault; machine is healthy. (2) FailedToStart - Last power-on operation for machine failed. (3) StuckOnBoot - Machine does not seem to have booted following power on. (4) Unregistered - Machine has failed to register within expected period, or its registration has been rejected. (5) MaxCapacity - Machine is reporting itself at maximum capacity.	State
Load Index	citrix.broker_desktop.load_index	Gives current effective load index for multi-session machines	Count
Load Indexes	citrix.broker_desktop.load_indexes	Gives the last reported individual load indexes that were used in the calculation of the LoadIndex value. Note that the LoadIndex value may have been subsequently adjusted due to session brokering operations. This value is only set for multi-session machines	Count

Metric name	Metric key	Description	Unit
Desktops Available	citrix.broker_group.desktops_available	The number of machines in the desktop group in state Available; this is the number of machines with no sessions present.	Count
Desktops Faulted	citrix.broker_group.desktops_faulted	The number of machines in the desktop group whose FaultState is not None.	Count
Desktops Preparing	citrix.broker_group.desktops_preparing	The number of machines in the desktop group whose PvD disk image is being prepared.	Count
Desktops Unregistered	citrix.broker_group.desktops_unregistered	The number of machines in the desktop group that are currently unregistered.	Count
Desktops In Use	citrix.broker_group.desktops_in_use	The number of machines in the desktop group in state InUse; this is the number of machines with at least one session present.	Count
Desktops Disconnected	citrix.broker_group.desktops_disconnected	The number of disconnected sessions present on machines in the desktop group.	Count
Desktops Total	citrix.broker_group.total_desktops	Total number of machines in the desktop group.	Count
Desktops Never Registered	citrix.broker_group.desktops_never_registered	The number of machines in the desktop group that have never registered with the current site	Count
Sessions	citrix.broker_group.sessions	The total number of user sessions currently running on all of the machines in the desktop group.	Count
Applications	citrix.broker_group.total_applications	Total number of applications associated with the desktop group.	Count
Application Groups	citrix.broker_group.total_application_groups	Total number of application groups associated with the desktop group.	Count

Metric name	Metric key	Description	Unit
Assigned	citrix.broker_catalog.assigned	The number of assigned machines (machines that have been assigned to a user/users or a client name/address).	Count
Available	citrix.broker_catalog.available	The number of available machines (those not in any desktop group).	Count
Available Unassigned	citrix.broker_catalog.available_unassigned	The number of available machines (those not in any desktop group) that are not assigned to users.	Count
Unassigned	citrix.broker_catalog.unassigned	The number of unassigned machines (machines not assigned to users).	Count
Used	citrix.broker_catalog.used	The number of machines in the catalog that are in a desktop group.	Count

Metric name	Metric key	Description	Unit
Active Sessions	citrix.broker_site.licensed_sessions_active	The count of active licensed sessions	Count
Unique Users	citrix.broker_site.total_unique_license_users	The total count of license users	Count
License Model	citrix.broker_site.license_model	The licensing model in use. Values can be 0 - 'Concurrent' or 1 - 'UserDevice'	State
Broker Service Status	citrix.broker_site.service_status	Enables the status of the Broker Service on the controller to be determined. If the service has multiple data stores it will return the overall state as an aggregate of all the data store states. 1 - DBUnconfigured 2 - DBRejectedConnection 3 - InvalidDBConfigured 4 - DBNotFound 5 - DBMissingOptionalFeature 6 - DBMissingMandatoryFeature 7 - DBNewerVersionThanService 8 - DBOlderVersionThanService 9 - DBVersionChangeInProgress 10 - OK 11 - PendingFailure 12 - Failed 13 - Unknown	State

Metric name	Metric key	Description	Unit
VDAs Registered	citrix.broker_controller.desktops_registered	The number of VDA machines registered with the Broker service on the controller	Count
Licensing Server State	citrix.broker_controller.licensing_server_state	The licensing server state currently in effect in the Broker service on the controller ServerNotSpecified (1), NotConnected (2), OK (3), LicenseNotInstalled (4), LicenseExpired (5), Incompatible (6), Failed (7)	State
State	citrix.broker_controller.state	The state of the Broker service on the controller (1) Failed, (2) Off, (3) On, (4) Active.	State
Licensing Server Last Event Time	citrix.broker_controller.last_licensing_server_time	Time at which the last significant licensing server event was reported	Second
Active Services	citrix.broker_controller.active_services	The Broker site services active on the controller	Second

Related to Citrix Virtual Apps and Desktops

OneAgent

The simplest way to capture all observation signals automatically and in context.

Full version history

To have more information on how to install the downloaded package, please follow the instructions on this page.

ReleaseDate

Version 1.1.2

Add support for sending detailed data as logs

Version 1.0.6

Remove the whoami.exe command from the fastcheck for SDK mode

Version 1.0.5

Log files are now unique per user configured
Give extra details when fastcheck fails for SDK mode

Version 1.0.4

Reduce the cardinality of Citrix VDA metrics to support very large environments
Removes the session_user_name dimension for VDA metrics

Version 1.0.3

Fix an issue where VDAs with different timezones were not reporting beacon correctly

No release notes

Dynatrace Hub

Build your own app

All (668)Log Management and Analytics Kubernetes Infrastructure Observability Automations Application Observability Application Security Digital Experience Business Analytics

Dynatrace Developer

Discover recent additions to Dynatrace

Site Reliability Guardian

Get automated change impact analysis for release and change validation.

DevSecOps Lifecycle Coverage with Snyk

Connect Snyk container scans and Dynatrace runtime insights for strong security.

Business Flow

Track, analyze, and optimize your critical business processes.

Salesforce Insights

Monitor Salesforce performance, user experience, adoption, and threats.

Carbon Impact

Track, analyze and reduce the carbon footprint of your hybrid cloud environment.

Analyze your data

Understand your data better with deep insights and clear visualizations.

Notebooks

Create powerful, data-driven documents for custom analytics and collaboration.

Dashboards

Transform complex data into clear visualizations with custom dashboards.

Automate your processes

Turn data and answers into actions, securely, and at scale.

Workflows

Automate tasks in your IT landscape, remediate problems, and visualize processes

Jira for Workflows

Create, query, comment on, and resolve Jira tickets within your workflows.

Slack for Workflows

Automate Slack messaging for security incidents, attacks, remediation, and more.

Secure your cloud application

See vulnerabilities and attacks in your environment.

Security overview

Get a comprehensive overview of the security of your applications.

Third-party vulnerabilities

Detect vulnerabilities in real time, with context and automated risk assessment.

Code-level vulnerabilities

Detect vulnerabilities in your code in real time.

Attacks

Get a real-time overview of all the attacks on your environment.

Are you looking for something different?We have hundred of apps, extensions, and other technologies to customize your environment

Leverage our newest innovations of Dynatrace Saas

Kick-start your app creation

Kick-start your app creation

Whether you’re a beginner or a pro, Dynatrace Developer has the tools and support you need to create incredible apps with minimal effort.

Go to Dynatrace Developer

Upgrading from Dynatrace Managed to SaaS

Upgrading from Dynatrace Managed to SaaS

Drive innovation, speed, and agility in your organization by seamlessly and securely upgrading.

Log Management and Analytics

Log Management and Analytics

Innovate faster and more efficiently with unified log management and log analytics for actionable insights and automation.