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.

Note: 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.

Note: When HealthCheck method is HealthCheckURL or ContentVerification, for HTTPS based Load Balanced Target Groups, the Core Engine looks for Certificates under JRE's cacerts instead of Keystore configured for Target Operation.
  • 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
  • TCPEcho

    For TCPEcho Health Check to work, a TCP echo server needs to be running on the host where the target service runs and the echo server must listen on the port specified in the Health Check configuration. The TIBCO API Exchange Gateway engine will connect to this server, send a message and expects the echo server to send the same message back. Note that TCPEcho Health Check will only indicate whether the host on which the target service is running is up or not.

    Configure the following parameters for the TCPEcho method:

    • TCP Host
    • TCP Port
  • 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