Documentation

Contents
Contents
Contents
Contents

Citrix Cloud Monitoring

Disclaimer: The Citrix Cloud monitoring is making use of the Citrix Virtual Apps and Desktops OData APIs. These APIs are currently in Tech Preview state!

What Is Citrix Cloud Monitoring?

Citrix Cloud monitoring is uberAgent’s new capability to monitor the Citrix Virtual Apps and Desktops (CVAD) control plane in Citrix Cloud. This is an exciting feature for customers who do not host delivery controllers on-premises but leverage Citrix Cloud instead.

Which Metrics Are Collected By Citrix Cloud Monitoring?

Citrix Cloud monitoring collects a rich set of metrics about many aspects of a Citrix Cloud deployment (see the metrics documentation for details):

  • Published applications
  • Desktops
  • Desktop groups
  • Machines
  • Machine Catalogs

Enabling or Disabling Citrix Cloud Monitoring

Citrix Cloud monitoring is disabled by default. You can enable the data collection through the configuration setting [CitrixCloud_Config] in uberAgent’s configuration.

To completely disable Citrix Cloud monitoring, disable the following metrics in the configuration:

  • CitrixDCDesktopGroup
  • CitrixDCCatalog
  • CitrixDCMachine
  • CitrixDCGeneralInformation
  • CitrixDCApplication
  • CitrixDCPublishedDesktops

Installation and Configuration

To enable the Citrix Cloud data collection, please configure the stanza [CitrixCloud_Config] in uberAgent’s configuration. Make sure that this setting is only distributed to the machines that are intended for this purpose. If you distribute it with CollectCitrixCloudInformation=True to all machines where uberAgent is installed, every endpoint communicates with the Citrix Cloud APIs, which could overload the APIs and generate unnecessary data.
CollectCitrixCloudInformation=MachineList in combination with a set of machines configured in CollectCitrixCloudInformationMachines, defines on which machines the collection of Citrix Cloud metrics will be performed.

uberAgent Configuration

This section explains the configuration via uberAgent’s configuration file. The configuration via GPO works accordingly.

Use the stanza [CitrixCloud_Config] to specify how uberAgent should connect to the Citrix Cloud infrastructure. If multiple [CitrixCloud_Config] stanzas are specified, the configured metrics are determined for each of them. Use one [CitrixCloud_Config] stanza per Citrix Cloud tenant.

Following are some examples of valid Citrix Cloud monitoring configurations. More information on the parameters is available in the configuration file itself.

Example 1: one Citrix Cloud tenant. Data collection happens on all uberAgent endpoints.

[CitrixCloud_Config]
API endpoint = https://api-eu.cloud.com/monitorodata/
CustomerId = <CustomerId>
ClientId = <ClientId>
ClientSecret = <ClientSecret>
CollectCitrixCloudInformation=True

Example 2: one Citrix Cloud tenant. Data collection happens on specific endpoints only.

[CitrixCloud_Config]
API endpoint = https://api-eu.cloud.com/monitorodata/
CustomerId = <CustomerId>
ClientId = <ClientId>
ClientSecret = <ClientSecret>
CollectCitrixCloudInformation=MachineList
CollectCitrixCloudInformationMachines = MachineA,MachineB

Requirements

Create a Citrix Cloud API client as described here.

The following component must be present on the endpoint to collect Citrix Cloud metrics:

  • Citrix Virtual Apps and Desktops Remote PowerShell SDK (details)
    • Please don’t install the Remote PowerShell SDK on Citrix Virtual Apps and Desktops delivery controllers.
    • Please don’t install the Remote PowerShell SDK on Citrix Cloud Connector machines.

Please see the system requirements page for details.

Leave a Reply

Your email address will not be published. Required fields are marked *