Specifying a Timeout Value for a Service Health Check Invocation

The timeout element in a Service Health Check request specifies a value, in milliseconds, which is the maximum time duration for which the Service Health Check invocation remains in progress. After the timeout period elapses, a Service Health Check response is returned to the user with status="TimedOut" and an error message indicating the probable cause. This element is useful for troubleshooting.

Also, various resources used during the Service Health Check execution (connections, threads, and so on) are released after the timeout period elapses, thus concluding the exchange.

Enter the Timeout Value for a Service Health Check Invocation in input box Timeout value (milliseconds) provided while invoking Service Health Check.

Note: If no value is specified in Timeout value input box, Service Health Check times out by default after internal connection timeout of 9 seconds or socket timeout of 3 seconds.

The com.tibco.amx.servicehealthcheck.componentResponseWaitTime property is used to specify the time a Caller component (such as an ImplementationType Component, or a Binding Type Component), must wait till it receives a response from its callee. The default value is 100 milliseconds.

Sample Timeout Response

When a Component times out because one of its Component References ("BookingReference" in the snippet below) has timed out, the Service Health Check response for that Component contains the following fragment: 

<ComponentReference name="BookingReference">
  <Error>
    <errorCode>TIBCO-AMX-DT-000005</errorCode>
    <errorString>Health Check execution stopped due to Timeout.</errorString>
  </Error>
</ComponentReference>