High Availability - CCGC Test

A high availability (HA) deployment of two Citrix Cloud Gateway Connectors can provide uninterrupted operation in any transaction. With one connector configured as the primary node and the other as the secondary node, the primary node accepts connections and manages servers while the secondary node monitors the primary. If, for any reason, the primary node is unable to accept connections, the secondary node takes over.

The secondary node monitors the primary by sending periodic messages (often called heartbeat messages or health checks) to determine whether the primary node is accepting connections. If a health check fails, the secondary node retries the connection for a specified period, after which it determines that the primary node is not functioning normally. The secondary node then takes over for the primary (a process called failover).

When monitoring a Citrix Cloud Gateway Connector, you may first want to know whether the target connector has been deployed in an HA setup or not. If so, you may then want to time and again evaluate the effectiveness of the HA configuration, by checking the following:

  • What is the current status of highly available node in the HA setup?
  • What is the current status of target connector in the HA setup?
  • Has the status of target connector changed?

This is exactly what the High Availability - CCGC test does.

Target of the test : A Citrix Cloud Gateway Connector

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the Citrix Cloud Gateway Connector to be monitored.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The host for which the test is to be configured.

Port

The port at which the connector listens. By default, this is 8443.

Username and Password

To monitor a Citrix Cloud Gateway Connector, the eG agent should be configured with the credentials of a user with read-only privileges to the target connector. Specify the credentials of such a user in the Username and Password text boxes.

Confirm Password

Confirm the Password by retyping it here.

SSL

By default, the SSL flag is set to No indicating that the eG agent will communicate with the connector via HTTP by default. If the target connector is SSL-enabled, then set this flag to Yes to enable the eG agent to communicate with target connector via HTTPS.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

HA current state

Indicates the current state of the highly available node.

 

The values that this measure can report and their numeric equivalents are as shown in the table below:

Measure Value Numeric Value
Up 0
Init 1
Disabled 2
Partially failed 3
Completely failed 4
Dumb 5
Partially SSL card failed 6
Route monitor failed 7

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current state of the highly available node. However, in the graph of this measure, the state will be represented using the corresponding numeric equivalents only.

HA current master state

Indicates the current state of the master connector in a high availability setup.

 

The values that this measure can report and their corresponding numeric equivalents are shown in the table below:

Measure Value Numeric Value
Primary 0
Secondary 1
Stay Secondary 2
Claiming 3
Force change 4

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current status of the master node. However, in the graph of this measure, the states will be represented using the corresponding numeric equivalents only.

Is master state changed?

Indicates whether/not the state of the target connector changed since the last measurement period.

 

The values that this measure can report and their corresponding numeric equivalents are shown in the table below:

Measure Value Numeric Value
No 0
Yes 1

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether/not the state of the master is changed. However, in the graph of this measure, the states will be represented using the corresponding numeric equivalents only.