Health Checks

Introduction

WebTSM Service health checks can be used to determine the status of a service.

Some configuration may be necessary, for more information on available configuration options please refer to: Configuration Health Checks

Health Check Requests

There are two endpoints available for requesting the status of a service:

Check Live Status

In order to check if a service is up and running the following request may be used

CODE

GET /health/live

This request returns a status 200 OK "Healthy" response if the service is running and can be reached.

In case the service can not be reached no response will be returned, since the request can not be processed without an available service.

Check Ready Status

For more detailed information on the status of a service the following request is available:

CODE

GET /health/ready

This request will respond with 200 OK "Healthy" if all of the following conditions are met:

IntegratedIdentityProvider is enabled and the database connection configured for user management is reachable
All database connections are reachable
IdentityProvider is reachable (if configured)
Configured UnhealthyMemoryAllocationLimit is not exceeded

A 503 Service Unavailable "Unhealthy" response will be returned if one of the conditions listed above fails.

In case all "Healthy" conditions are met but the allocated memory exceeds the configured limit for the degraded status a 200 OK "Degraded" response will be returned.

Details to health checks, for example which condition was not met when getting an "Unhealthy" response, may be found in the log file.

Graceful Shutdown Health Check

Since version 3.11.2, the WebTSM Service includes a Graceful Shutdown Health Check that ensures no new requests are routed to an instance that is in the process of shutting down. When the hosting environment triggers the ApplicationStopping event (e.g., during scaling operations), the service now reports an Unhealthy status so that load balancers stop forwarding new traffic, while already‑running requests continue to execute until the configured shutdown timeout window passes. The timeout duration can be customized through the new configuration entry:

XML

<HAKOMConfiguration>
  <products>
    <WebTSMServices>
      <HealthChecks>
        <ShutdownTimeout>00:00:20</ShutdownTimeout> <!-- Default is 10 seconds -->
      </HealthChecks>
    </WebTSMServices>
  </products>
</HAKOMConfiguration>