Login Details - Cloud Test

For every type of session (HDX and RDP) that is established on the controller, this test reports the total number of new sessions and the count of sessions that are logging out.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each session type; an All descriptor also appears, which reports aggregated metrics across all session types.

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 get the customer ID for the API client that you have created in your environment, do the following: Sign in to the Citrix Cloud administrator console. Click the “hamburger menu” in the upper left corner of the console. Select “Identity and Access Management” from the drop-down menu. An API Access page (see Figure 1 ) will open in the right panel. Look for the phrase , "use <customerID> as the customer parameter" in the right panel. The <customerID> displayed within that phrase (as highlighted in Figure 1) is the customer ID you need to configure the eG tests with. Figure 1 : Customer ID mapped to the 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 this test with the full path to the secureclient.csv here.
Report by Machine Type	By default, this flag is set to Yes indicating that the individual descriptors of this test - i.e., the catalogs - are classified based on their machine type; in other words, the catalogs 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 catalogs based on their machine types, set this flag to No.
Proxy Host	If the eG agent communicates with the Citrix Cloud via a proxy, then specify the IP address/fully-qualified host name of the proxy server here. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.
Proxy Port	If the eG agent communicates with the Citrix Cloud via a proxy, then specify the port at which the proxy server listens for requests from the eG agent. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.
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: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Current sessions	Indicates the current number of user sessions of this type on the controller.	Number	This count includes both the currently active sessions and inactive sessions. To know which sessions are active and which are inactive, use the detailed diagnosis of this measure.
New sessions	Indicates the number of sessions of this type that have been established newly on the controller.	Number	A consistent zero value could indicate a connection issue.
Percent new sessions	Indicates the percentage of current sessions of this type that were established on the controller during the last measurement period.	Percent
Sessions logging out	Indicates the number of sessions of this type that logged out of the controller.	Number	If all the current sessions suddenly log out, it indicates a problem condition that requires investigation. The detailed diagnosis of this measure lists the sessions that were logged out.

For details of the current sessions, use the detailed diagnosis of the Current sessions measure. This provides the complete details of every session on the controller. The details include: the session ID, the machine from which the session was launched and the endpoint of the session, the delivery group to which the machine belongs, the hypervisor used, the IP address of the NetScaler and StoreFront used for the session, the state of each sessions, and the time taken to broker and to establish the session. This way, administrators can quickly isolate that session that took the longest to broker or establish. Inactive/disconnected sessions can also be so identified.

Figure 2 : The detailed diagnosis of the Current sessions measure