Session and Application States - Cloud Test

In the event of a session overload on the Citrix Cloud, administrators may want to know the type of sessions that may have contributed to the overload – HDX sessions? or RDP sessions? This can be determined using the Session and Application States test. For every type of session (HDX and RDP) on the controller, this test reports the total session count and the status of the sessions.

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 the below figure) 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.

Show Desktop Session DD

By default, this flag is set to No. This means that, by default, this test does not report detailed metrics for its Desktop sessions measure. If you want to know more details about the desktop sessions on the controller, enable detailed diagnostics collection for the Desktop sessions measure by setting this flag to Yes.

Show Mobile Session DD

By default, this flag is set to No. This means that, by default, this test does not report detailed metrics for its Mobile sessions measure. If you want to know more details about the mobile sessions on the controller, enable detailed diagnostics collection for the Mobile sessions measure by setting this flag to Yes.

Proxy Host, Proxy Port, Proxy User Name, Proxy Password, and Proxy SSL

These parameters are applicable only if the Citrix Cloud Connector communicates with the Citrix Cloud via a Proxy server.

If the Proxy server requires authentication, then specify the credentials of a valid Proxy user against the Proxy User Name and Proxy Password text boxes. Confirm that password by retyping it in the Confirm Password text box. If the Proxy server does not require authentication, then specify none against the Proxy User Name, Proxy Password, and Confirm Password text boxes.

By default, the Proxy SSL flag is set to No. If the specified proxy server is SSL-enabled, then set the Proxy SSL flag to Yes

On the other hand, if the Citrix Cloud Connector is not using a Proxy server to communicate with the Citrix Cloud, then you need not disturb the default setting of any of the Proxy-related parameters. By default, these parameters are set to none.

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

Total sessions

Indicates the total number of user sessions.

Number

This is a good indicator of the session load on the controller. If a consistent increase is observed in the value of this measure for the All descriptor, it could hint at a potential overload condition. In such situations, you can compare the value of this measure across session types to figure out which type of session is high on the controller – HDX or RDP?

Active sessions

Indicates the number of user sessions of this type that are currently active on the controller.

Number

A consistent zero value could indicate a connection issue.

For details of the currently active sessions, use the detailed diagnosis of this measure.

Connected sessions

Indicates the number of sessions of this type that are currently connected.

Number

The detailed diagnosis of this measure if enabled, lists the Session ID, the name of the machine, the name of the catalog and delivery group to which the machine belongs, the zone to which the catalog belongs, the server on which the machine is hosted, the hypervisor name, the user who is active on the session, the protocol used for connecting to the session, the Client IP and version, the state of the session, the time for which the session is connected, the time at which the state of the session changed, the start time of the session, the controllering time, the number of session supported – whether single session or multiple session, the applications that are currently in use if the machine in operation is a XenApp etc.

Disconnected sessions

Indicates the number of sessions of this type that are currently disconnected.

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.

Reconnecting sessions

Indicates the number of sessions of this type that are reconnecting soon after a disconnect.

Number

The detailed diagnosis of this measure lists the sessions that reconnected soon after a disconnect.

Preparing sessions

Indicates the number of sessions of this type that are currently in the Preparing state.

Number

The detailed diagnosis of this measure lists the sessions that are currently in the Preparing state.

Non-brokered sessions

Indicates the number of user sessions of this type that were not brokered by the machines managed by this controller.

Number

The detailed diagnosis of this measure lists the sessions that were not brokered by the machines managed by this controller.

Unknown sessions

Indicates the number of sessions of this type that are currently in Unknown state.

Number

The detailed diagnosis of this measure lists the sessions that are currently in Unknown state.

Other sessions

Indicates the number of sessions of this type that are currently in Other state.

Number

The detailed diagnosis of this measure lists the sessions that reconnected soon after a disconnect.

Hidden sessions

Indicates the number of sessions of this type that are currently hidden.

Number

The detailed diagnosis of this measure lists the sessions that are currently hidden.

Autonomously brokered sessions

Indicates the number of sessions of this type that are brokered without the use of this controller.

Number

The detailed diagnosis of this measure lists the sessions that are autonomously brokered.

Pre-logon

Indicates the number of applications that are in pre-logon state for the sessions of this type.

Number

This measure is only applicable for Server OS Machines descriptor.

Use the detailed diagnosis of this measure to know which applications are in the pre-logon state.

Pre-launched

Indicates the number of applications for which sessions of this type are prelaunched.

Number

This measure is only applicable for Server OS Machines descriptor.

The session prelaunch enables all or specified users access applications quickly, by starting sessions before they are requested. The session will wait for a user, and when the user starts an application prelaunched session is replaced with a regular session.

Use the detailed diagnosis of this measure to know which applications are in the pre-launched state.

Active applications

Indicates the number of applications that are currently running in the sessions of this type.

Number

This measure is only applicable for Server OS Machines descriptor.

Use the detailed diagnosis of this measure to know which are the active applications.

Lingering

Indicates the number of sessions of this type that are in active state even after the applications are closed.

Number

This measure is only applicable for Server OS Machines descriptor.

Use the detailed diagnosis of this measure to know which sessions are active even after the applications are closed.

No applications

Indicates the number of sessions of this type that are active without any application launch.

Number

This measure is only applicable for Server OS Machines descriptor.

Use the detailed diagnosis of this measure to know which sessions are active without any application launch.

Desktop sessions

Indicates the number of active desktop sessions of this type.

Number

Use the detailed diagnosis of this measure, if enabled, to view the active desktop sessions.

Mobile sessions

Indicates the number of active mobile sessions of this type.

Number

Use the detailed diagnosis of this measure, if enabled, to view the active mobile sessions.

Anonymous users

Indicates the number of sessions established anonymously (without user credentials); in this case a temporary local user account on the machine is used.

Number

For details of the currently active sessions, use the detailed diagnosis of the Active sessions measure. This provides the complete details of every active 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, 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.

Figure 2 : The detailed diagnosis of the Active sessions measure