Load Evaluator Index - Cloud Test

A server’s load index may be the aggregate of:

  • Various computer performance counter based metrics, namely CPU, Memory and Disk Usage
  • Session Count

It is designed to indicate how suitable a XenApp Worker is to receive a new user session. It is the Citrix Cloud Delivery Controller's responsibility to calculate the load index based on the aggregate of the normalized load rule indexes generated by the various load rules. As only the Delivery Controller can determine the session load, a server’s overall load index is calculated on the Delivery Controller and not the Virtual Delivery Agent.

Administrators can use the Load Evaluator Index test to periodically evaluate the load on the servers managed by a delivery group. This is imperative to ensure that load is uniformly balanced across the servers. In addition, in times of an overload, this test can help administrators accurately identify which server is overloaded and which resource is the constraint.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for every delivery group of each server OS type

First-level descriptor: Server OS type

Second-level descriptor: Delivery Group

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.

Report by Delivery Group

By default, this flag is set to Yes indicating that this test reports metrics for each delivery group that contains machines running a particular server OS. The delivery group-level insight into the load evaluator index enables administrators to gauge the overall load on every delivery group. If required, you can change the status of this flag to No; in this case, this test will report metrics for every server OS machine in a delivery group. The machine-level insight into load enables administrators to understand whether/not load is uniformly balanced across the different server OS machines, and accurately identify the machine that is overloaded.

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.

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

Effective load evaluator index

Indicates the load evaluator index of this delivery group / machine.

Percent

By comparing the value of this measure across delivery groups / server OS machines, you can figure out whether or not load is uniformly balanced across all delivery groups / servers.

Use the detailed diagnosis of this measure to view the complete details of the machines in a delivery group and to view the CPU, disk, memory, and session load evaluator index of each machine.

CPU load evaluator index

Indicates the CPU load evaluator index of this delivery group / server OS machine.

Percent

A high value is indicative of excessive CPU usage by the delivery group / machine over time.

Memory load evaluator index

Indicates the memory load evaluator index of this delivery group / server OS machine.

Percent

A high value is indicative of excessive memory usage by the delivery group / machine over time.

Disk load evaluator index

Indicates the disk load evaluator index of this delivery group / server OS machine.

Percent

A high value is indicative of excessive disk usage by the delivery group / machine over time.

Session load evaluator index

Indicates the session count load evaluator index of this delivery group / server OS machine.

Percent

A high value indicates that the delivery group / machine has been consistently handling many user sessions.

Use the detailed diagnosis of the Effective load evaluator index measure to know which machines are in the delivery group and the CPU, disk, memory, and session load evaluator index of each machine.

Figure 1 : Detailed diagnosis of the Effective Load Evsaluator Index measure