Copyright © Cloud Software Group, Inc. All Rights Reserved

HealthCheck for Reference

TIBCO API Exchange Gateway provides HealthCheck for Reference functionality to monitor the availability of the target operations in a target operations group.

The Load Balancing Router component of the TIBCO API Exchange Gateway uses the HealthCheck for Reference functionality when it routes an operation request to a target operation group.

TIBCO API Exchange Gateway supports the HealthCheck for Reference functionality for the following types of target operation group:

•	RoundRobinWithFailover

•	WeightedRoundRobinWithFailover

When a facade operation request is routed to a target operation group of the RoundRobinWithFailover or WeightedRoundRobinWithFailover type, the Load Balancer Router of the gateway uses HealthCheck for Reference to check the health of the target operations configured in the target operations group. If the selected target operation is not available or running, the gateway forwards the request to an alternate target operation which is running.

Using the HealthCheck for Reference functionality, the router component of the gateway intelligently picks the available target operation. This increases the throughput and reduces the latency of the request processing at runtime.

The HealthCheck for Reference functionality is available to the Gateway Load balancer Router component to monitor the health of target operations in a target operations group with failover routing algorithms only (RoundRobinWithFailover or WeightedRoundRobinWithFailover).

HealthCheck Modes for a Target Operation

HealthCheck for Reference provides the following modes for any target operation in a target operations group:

•

Timer

For each target operation in the target operation group, you can configure a timer-based HealthCheck. Healthcheck for Reference checks the status of the target operation each time the timer expires. You must configure a HealthCheck method for the timer mode. See HealthCheck Methods for Timer Mode for the details.

•

Reset

You can configure the reset mode HealthCheck for each target operation in the target operation group. When Reset mode is used, the HealthCheck for Reference resets the health status of a target operation after the specified interval (in milliseconds). See Reset Interval.

Reset Interval

The HealthCheck module resets the health status of a target operation after the time interval as specified by the ResetInterval configuration parameter. This parameter is used when the Reset mode for the HealthCheck configuration is selected for a target operation in the target operation group.

HealthCheck Methods for Timer Mode

Choose a method for the timer mode of HealthCheck. HealthCheck for Reference uses a specified method to check the health status of the target operation. The following types of HealthCheck methods are supported:

•

HTTP

The Core Engine forms an HTTP- based URL from the fields configured for the HTTP- based target operation such as service-type, URI, host, and port. Once the URL is formed, the Core Engine invokes an HTTP connection to ping the target operation. Based on the response code returned from the HTTP connection, HealthCheck for Reference determines the health of the target operation. For example, if the returned response code indicates a success, the HealthCheck for Reference returns that the target operation is running. If the returned response code indicates a failure, the HealthCheck for Reference returns that the target operation is not running. The response code returned is checked to determine the heath of the target operation.

•

HTTPs

The Core Engine forms a based URL from the fields configured for the based target operation such as service-type, URI, host, port and the SSL properties set in dss.properties. After the URL is formed, the Core Engine invokes a URL connection to ping the target operation. Based on the response code returned from the HTTP connection, HealthCheck for Reference determines the health of the target operation. For example, if the returned response code indicates a success, the HealthCheck for Reference returns that the target operation is running. If the returned response code indicates a failure, the HealthCheck for Reference returns that the target operation is not running.

For the HTTPs based target operation, configure the SSL properties for mutual SSL authentication. If the HTTPs based target operation is enabled for one-way authentication, SSL properties configuration is not required.

•	HealthCheckURL

Using the HealthCheckURL method, you can specify the URL to invoke a HTTP connection. The Core Engine attempts to invoke the HTTP connection with the configured URL for this method. The Core Engine uses the returned response code to determine the heath of the target operation. For example, if the returned response code is a success, the HealthCheck returns that the target operation is running. If the returned response code is a failure, the HealthCheck returns that the target operation is not running.

•

TCPEcho

The TCPEcho method expects that the TCP server is running at the specified host and port configured for this method. TCPEcho method sends a ping request to the running TCP server. HealthCheck for Reference uses the returned echo response to determine if the target operation is running or not.

Configure the following parameters for the TCPEcho method:

−

TCP Host

−

TCP Port

•	ContentVerification

The ContentVerification method uses the configured HealthCheck URL and sends an HTTP GET request to the URL. The HealthCheck for Reference examines the returned response content and searches for the configured keyword in the response content. If the keyword is found in the response content returned from the HTTP GET request, the HealthCheck returns that the target operation is running. If the keyword is not found in the response content returned from the HTTP GET request, the HealthCheck returns that the target operation is not running.

Configure the following parameters for the TCPEcho method:

−	Health Check URL

−

Keyword

•	SampleRequest

The SampleRequest method reads the data from a file as specified by the Content File parameter and sends the data content of this file in the HTTP POST request to the URL specified by the Health Check URL parameter to check the health of the target operation. The HealthCheck module examines the returned response code to determine if the target operation is running or not.

Configure the following parameters for the TCPEcho method:

−	Health Check URL

−	Content File

HealthCheck Configuration for Target Operation

This section explains the configuration set up to use the HealthCheck for Reference functionality for the target operations in a target operation group. Configure the HealthCheck parameters for each target operation in a target operation group for RoundRobinWithFailover or WeightedRoundRobinWithFailover group type.

Configuration for Reset Mode of HealthCheck

When you enable the Reset mode of HealthCheck for each target operation in a target operation group of RoundRobinWithFailover or WeightedRoundRobinWithFailover, configure the ResetInterval parameter.

To configure the ResetInterval parameter for a target operation, follow these steps:

1.	Start the GUI server, if not already running.

2.	Log in to the Config UI using your credentials.

3.	Add a new project or select an existing project under Projects, as applicable.

4.	Click the Target Operation Groups tab.

5.	Select a target operation group and expand the node.

6.	Select a Target Operation of RoundRobinWithFailover or WeightedRoundRobinWithFailover type for the Type parameter from the drop-down list.

7.	Expand the Health Check node.

8.	Select Reset for the Health Check Mode parameter from the drop-down list.

9.	Type the value of the Reset Interval parameter. See Reset Interval.

Configuration for Timer Based HealthCheck

After you enable the timer-based HealthCheck for each target operation in a target operation group of RoundRobinWithFailover or WeightedRoundRobinWithFailover, you must configure the HealthCheck parameters.

To configure the HealthCheck parameters for a target operation, follow these steps:

1.	Start the GUI server, if not already running.

2.	Log in to the Config UI using your credentials.

3.	Add a new project or select an existing project under Projects, as applicable.

4.	Click the Target Operation Groups tab.

5.	Select a Target Operation of RoundRobinWithFailover or WeightedRoundRobinWithFailover type for the Type parameter from the drop-down list.

6.	Expand the Health Check node to enter the HealthCheck configuration parameters described as follows:

Table 83 HealthCheck Configuration Parameters

Parameter	Description
Health Check Mode	• Specifies the mode for the HealthCheck functionality. • The possible values are: − Timer − Reset • Select Timer from the drop-down list.
Health Check Method	• Specifies the method to be used by HealthCheck to check the availability of the target operation. The possible values are: − HTTP − HTTPS − HealthCheckURL − TCPEcho − ContentVerification − SampleRequest • This is a Required field.
Check Interval	Specifies a time interval (in millseconds) which is used by HealthCheck as an expiration time to check the health status of the target operation. For example, if this value is specified as 10000, the HealthCheck checks the health status of the target operation after every 10 seconds, whether the target operation is running or not. The health status of the target operation is used by routing functionality to determine whether to route a request to this target operation or not.

7.	Save the changes to your configuration.

Configuration for HTTP HealthCheck Method

If you want to use the HealthCheck method as HTTP, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select HTTP in the Health Check Method field from the drop-down list.

Configuration for HTTPS HealthCheck Method

If you want to use the HealthCheck method as HTTPS, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select HTTPS in the Health Check Method field from the drop-down list.

Configuration for HealthCheckURL HealthCheck Method

If you want to use the HealthCheck method as HealthCheckURL, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select HealthCheckURL in the Health Check Method field from the drop-down list.

•	Enter the following parameter:

−	Health Check URL: specifies the URL to invoke a HTTP connection. See HealthCheckURL.

Configuration for TCPEcho HealthCheck Method

If you want to use the HealthCheck method as TCPEcho, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select TCPEcho in the Health Check Method field from the drop-down list.

•	Enter the parameters described as follows:

Table 84 TCPEcho HealthCheckMethod Configuration Parameters

Parameter	Description
TCPHost	Specifies the host on which the TCP server is running.
TCPPort	Specifies the port on which the TCP server is running.

Configuration for ContentVerification HealthCheck Method

If you want to use the HealthCheck method as ContentVerification, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select ContentVerification in the Health Check Method field from the drop-down list.

•	Enter the parameters described as follows:

Table 85 ContentVerification HealthCheckMethod Configuration Parameters

Parameter	Description
Health Check URL	Specifies the URL to which the heathcheck module sends the HTTP GET request.
Keyword	Specifies the keyword to be searched in the content returned in response to the HTTP GET request.

Configuration for SampleRequest HealthCheck Method

If you want to use the HealthCheck method as SampleRequest, follow these steps:

•	Configure the parameters as explained in HealthCheck Configuration Parameters table.

•	Select SampleRequest in the Health Check Method field from the drop-down list.

•	Enter the parameters described as follows:

Table 86 SampleRequest HealthCheckMethod Configuration Parameters

Parameter	Description
Health Check URL	Specifies the URL to which the HealthCheck for Reference sends the HTTP POST request.
Content File	Specifies a file from where the HealthCheck for Reference reads the data contents and sends it in HTTP POST request.
Existing Content File	Specifies an existing content file from the HealthCheck directory under ASG_CONFIG_HOME. The HealthCheck directory is created when the first file is uploaded. The HealthCheck for Reference reads the data contents from this content file and sends it in the HTTP POST request.

Copyright © Cloud Software Group, Inc. All Rights Reserved