Health Checks

Introduction

WebTSM Services offer health checks to evaluate the status of your service based on criteria some of which are configurable.

This page explains the configuration options pertaining to health checks. For information on how to use the health checks or interpret the responses please refer to the relevant documentation: Using WebTSM Service Health Checks

Configuration

Settings concerning WebTSM Services health checks are located here in the HAKOM.Config:

XML

<HAKOMConfiguration>
    <products>
        <WebTSMServices>
            <HealthChecks>
				<!-- Settings -->
            </HealthChecks>
       </WebTSMServices>
    </products>
</HAKOMConfiguration>

The following settings provide options for configuring the health checks of a service:

Element	Description	Default Value
DegradedMemoryAllocationLimit	If the configured limit is exceeded, the status of the service will be "Degraded".	unlimited (bytes)
UnhealthyMemoryAllocationLimit	If the configured limit is exceeded, the status of the service will be "Unhealthy".	unlimited (bytes)
RepositoryReadyCheckInterval	How often the background worker probes each configured repository connection to refresh the cached readiness state.	00:10:00 (TimeSpan (hh:mm:ss))
RepositoryReadyMaxDegreeOfParallelism	The maximum number of repository connections the background worker probes in parallel during a single check cycle.	4 (int)

Docker

Docker itself provides the functionality to execute health checks for dockerized deployments of HAKOM WebTSM Services. In order to use this feature it is necessary to create a separate image based on the HAKOM WebTSM image:

PowerShell

from webtsmservices

HEALTHCHECK --interval=45s --timeout=4s CMD curl -f http://localhost/api/health/ready || exit 1

The path provided for the parameter -f has to be identical to the path configured in the HAKOM.Config. The other parameters "interval" and "timeout" can of course be configured to fit the specific requirements of the service.

For more information about Docker health checks please refer to: https://docs.docker.com/engine/reference/builder/#healthcheck