Configuring on-premises Sites with Citrix Analytics for Performance

Citrix Analytics for Performance (Performance Analytics) is the comprehensive performance monitoring solution from the Citrix Analytics Cloud Service. Performance analytics provides advanced insights and analytics built on performance metrics. Performance Analytics helps you monitor and view the usage and performance metrics of one or more Citrix Virtual Apps and Desktops Sites in your organization.

For more information about Performance Analytics, see the Performance Analytics article.

You can send performance data from your Site to Citrix Analytics for Performance on Citrix Cloud to leverage its advanced performance analytics capabilities. To view and use Performance Analytics, you must first configure your on-premises Sites with Citrix Analytics for Performance from the Analytics tab in Director. This feature requires Director on version 1909 or later, Delivery Controller and VDA on version 1906 or later.

Onboarding

Performance Analytics accesses data in a secure manner and no data is transferred from Citrix Cloud to the on-premises environment.

Prerequisites

To configure Performance Analytics from Director, no new components need to be installed. Ensure that the following requirements are met:

  • Your Delivery Controller and Director are on version 1909 or later. For more information, see Feature compatibility matrix.

  • Access to the Analytics tab to perform this configuration is available for full administrators only.

  • For Performance Analytics to access performance metrics, outbound internet access is available on all Delivery Controllers and the machines on which Director is installed. Specifically, ensure accessibility to the following URLs:

    • Citrix Key Registration: https://*.citrixnetworkapi.net/
    • Citrix Cloud: https://*.citrixworkspacesapi.net/
    • Citrix Analytics: https://*.cloud.com/
    • Microsoft Azure: https://*.windows.net/

Note: In case, Delivery Controllers and Director machines are within an intranet and outbound internet access is via a proxy server, the usedefaultproxy field in the config file controls the outbound access of Director and Monitor Service.

Configuration and communication with Performance Analytics requires the usedefaultproxy field to be set to true. Also, the proxy server must whitelist the preceding list of URLs. It is possible the policies in effect set this field to false. In this case, you must manually set the field to true on the Director machine, in the Director web.config file. And on the Delivery Controller, in the Citrix.Monitor.exe.config file.

Take a backup of the config files before you make the changes. Restart the Monitoring service on the Delivery Controller for the changes to be affected.

  • You have an active Citrix Cloud entitlement for Performance Analytics.

  • Your Citrix Cloud account is an Administrator account with rights to the Product Registration Experience. For more information about administrator permissions, see Modify Administrator Permissions.

Configuration steps

After you have verified the prerequisites, do the following:

  1. Log on to Director as a full administrator and select the Site which you want to configure with Performance Analytics.

  2. Click the Analytics tab. The Configuration page is displayed.

    Analytics tab

  3. Review the steps, select the terms of service, and then click Get Started.

    Get started

  4. Review the prerequisites and ensure that they are met. Review the Site Details.

  5. Click Connect Site to start the configuration process.

    Connect site

  6. A unique 8-digit registration code is generated to be used to register this Site with Citrix Cloud.

    Registration code

  7. Click Copy Code to copy the code and then click Register on Citrix Cloud.

  8. You are redirected to the Registration URL in Citrix Cloud. Log in with your Citrix Cloud credentials and select your customer.

  9. Paste the copied registration code in the Product Registrations page in Citrix Cloud. Click Continue to register. Review the registration details and click Register.

    Register in Citrix Cloud

  10. Your on-premises Site registers with Citrix Cloud. Now, from Director, click Go to Analytics in the Analytics tab.

    Go to Analytics

  11. Performance Analytics is opened on a new tab in your browser. Performance Analytics Dashboard

    If your Citrix Cloud session has expired, you might be redirected to the Citrix.com or My Citrix account logon page.

  12. To register multiple Sites with Performance Analytics, repeat the preceding configuration steps for each Site from Director. Metrics for all configured Sites are displayed on the Performance Analytics dashboard.

    In case you have more than one Director instance running per Site, configure from any one Director instance. All other Director instances connected to the Site are updated at the next refresh after the configuration process.

  13. To disconnect your Site from Citrix Cloud, click Disconnect Site. This option deletes the existing configuration.

    Notes:

    The first time you configure a Site, events from the Site might take some time (approximately an hour) to be processed; causing a delay in the display of metrics on the Performance Analytics dashboard. Thereafter, events refresh at regular intervals.

    Upon disconnect, data transmission from the old account continues for some time until the events from the new account are transmitted. For approximately one hour after data transmission stops, analytics related to the old account remain displayed on the Performance Analytics Dashboard.

    Upon expiry of entitlement to the Citrix Analytics service, it takes up to a day to stop sending the Site metrics to Performance Analytics.

Configuring on-premises Sites with Citrix Analytics for Performance