User Connection Failures - Cloud Test
If a user complains that his/her connections to a desktop/application failed, then administrators must be able to quickly detect the failure and accurately zero-in on the reason for the failure, so that the problem can be fixed and the user connection can be restored. The User Connection Failures test helps administrators do just that! This test monitors the user connections to each delivery group in a site, promptly detects connection failures, and accurately indicates what caused the failure – is it due to a problem at the client side? is it owing to configuration errors? is it because of machine failures? is it due to the exhaustion of delivery group capacity? Or is it due to the absence of a license?
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 each delivery group configured in the control plane
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 |
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:
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:
|
Report by Machine Type |
By default, this flag is set to Yes indicating that the individual descriptors of this test - i.e., the delivery groups- are classified based on their machine type; in other words, the delivery groups will be listed either under Server OS Machines or Desktop OS Machines based on their machine type. If you do not want to group the delivery groups based on their machine types, set this flag to No. |
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. |
DD Frequency |
Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency. |
Detailed Diagnosis |
To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:
|
Measurement | Description | Measurement Unit | Interpretation | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Client connection failures |
Indicates the number of connections to this delivery group that failed due to a problem at the client side. |
Number |
A high value for this measure is a cause for concern. In such situations, use the table below to understand the common causes for these failures:
To know what action to take against each of the causes discussed above, use the table below:
|
||||||||||||||||||||||||||||||||
Configuration errors |
Indicates the number of connections to this delivery group that failed due to configuration errors. |
Number |
A high value for this measure is a cause for concern. In such situations, use the table below to understand the common causes for these errors:
To know what action to take against each of the causes discussed above, use the table below:
|
||||||||||||||||||||||||||||||||
Machine failures |
Indicates the number of connections to this delivery group that failed due to machine failures. |
Number |
A high value for this measure is a cause for concern. In such situations, use the table below to understand the common causes for these failures:
To know what action to take against each of the causes discussed above, use the table below:
|
||||||||||||||||||||||||||||||||
Unavailable capacity |
Indicates the number of connections to this delivery group that failed because the configured capacity of the machines was consumed. |
Number |
A high value for this measure is a cause for concern. In such situations, use the table below to understand the common causes for these failures:
To know what action to take against each of the causes discussed above, use the table below:
|
||||||||||||||||||||||||||||||||
Unavailable licenses |
Indicates the number of connections to this delivery group that failed because of the absence of a license. |
Number |
A high value for this measure is a cause for concern. In such situations, use the table below to understand the common causes for these failures:
To know what action to take against each of the causes discussed above, use the table below:
|