Controller Service Details - Cloud Test

This test auto-discovers the critical services executing on the Citrix Cloud Delivery Controller, and reports the status of each service. With the help of this test, you can promptly detect which services have failed currently.

Target of the test : A Citrix Cloud Control Plane

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the monitored plane.

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the host for which this test is to be configured.
Port	Refers to the port at which the specified host listens to.
Customer ID	When configuring the Citrix Cloud service, you should have created an API client on the cloud, so that any external program can communicate with the cloud. This API client is tied to a customer ID. The Citrix Cloud API requires this customer ID, when calling REST APIs. To determine the customer ID that is mapped to the API client you created, refer to Determining the Customer ID Mapped to an API Client.
Secure Client File Path	When creating the API client on the cloud, you will be provided with an ID and a Secret for your client. Downloading this information saves a file named secureclient.csv. The eG agent uses the ID and Secret stored in this file to connect to the Citrix Cloud API. This is why, you will have to configure the Citrix Cloud Connectivity test with the full path to the secureclient.csv. Note: Before specifying the path of the secureclient.csv file, make sure that the API client is created and this file downloaded by a valid Citrix cloud user with Read-only administrator rights to virtual apps/desktops. To know how to create this user on the cloud, refer to theCreating a New Citrix Cloud User for Monitoring PurposestopicTo know how this user can create an API client on the cloud, refer to Creating API Client on the Citrix Cloud.
Proxy Host and Proxy Port	If the Citrix Cloud Connector communicates with the Citrix Cloud via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Citrix cloud without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST. Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy. Note: Before configuring these test parameters, make sure that the proxy server settings are imported to the eG agent side from the connector. To know how to achieve this, refer to Configuring the eG Agent with Proxy Server Settings. To know what values you should configure these parameters with, do the following: Login to the system hosting the Citrix Cloud Connector being monitored. Open the Internet Explorer browser on that system, and click on the icon provided at the right corner of that browser. Clicking the icon will invoke a menu. Choose Internet Optionsfrom the menu. Then, select the Connections tab in the Internet Options window that appears. Now, click the LAN Settings button. This will open the Local Area Network (LAN) Settings window. In the Proxy Server section of this window, you will find that the Use a proxy server for your LAN check box is enabled. Configure the PROXY HOST and PROXY PORT parameters with the IP address and port numbers displayed in the Address and Port text boxes (respectively) under that check box. If the Use a proxy server for your LAN check box is not enabled, then it means that the connector is not communicating with the cloud via a proxy. In this case, you need not change the default configuration for these parameters.
Region Endpoint	By default, US is chosen from this list indicating that this test will report metrics for those organizations whose users and resources are located in the United States region. Sometimes, the eG agent may collect the required metrics with a minor time delay due to the users and resources being monitored are in a different region. To avoid such time delays and to ensure end-user proximity and offer the best user experience, administrators are allowed to change the region based on where most of the users and resources are located. For instance, if the users and resources are located in the Asia-Pacific South region or approximately nearer to the Asia-Pacific South region, then, administrators need to choose 'AP-S' from this list. However, from this list, administrators are required to choose only the region that they had chosen when they signed in for the first time after onboarding their organization to the target Citrix Cloud.

Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Broker service status

Indicates the current status of the broker service.

The Citrix Broker Service brokers connections from endpoint devices to desktops and applications.

The numeric values that correspond to the Measure Values that this measure can take are as follows:

Measure Value	Numeric Value
OK	1
DBUnconfigured	2
DBRejectedConnection	3
InvalidDBConfigured	4
Electroencephalographic	5
DBOlderVersionThanService	6
DBVersionChangeInProgress	7
PendingFailure	8
Failed	9
Unknown	10
DBNotFound	11
DBMissingOptionalFeature	12
DBMissingMandatoryFeature	13

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current state of the broker service. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents – i.e., 1 to 13.

Configuration service status

Indicates the current status of the Configuration Service.

The Citrix Configuration Service stores the configuration information related to Citrix services in the broker’s MS SQL database.

The values that this measure can report and their corresponding numeric values are as follows:

Measure Value	Numeric Value
OK	1
DBUnconfigured	2
DBRejectedConnection	3
InvalidDBConfigured	4
DBNotFound	5
DBNewerVersionThanService	6
DBOlderVersionThanService	7
DBVersionChangeInProgress	8
Failed	9
Unknown	10

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current status of the Configuration service. However, in the graph of this measure, the same will be represented using the corresponding numeric equivalents – i.e., 1 to 10.