

Basic Health Check¶

WSO2 Micro Integrator provides a dedicated API for checking the health of the server. This can be used by a load balancer prior to routing traffic to a particular server node.

The health check API has two behaviors depending on whether the deployment is mutable or immutable. If the deployment is mutable (which is mostly the configuration in centralized deployments), the probe will give a ready status when the server starts successfully. If the deployment is immutable, the probe will give a ready status only if all the CApps are deployed successfully during server startup. If there are faulty CApps, the probe will return the list of faulty CApps. The health check API serves at:

http://localhost:9201/healthz

The health check can be performed over HTTPS APIs by adding the below configuration to the deployment.toml file.

[readiness_probe]
protocols = "http https"

Sample Request

curl GET 'https://localhost:9164/healthz' -k

Note

If you are running the server instance with a different port offset other than the default, which is 10, the heath check API will serve at 9191 + offset.

Health checking in Kubernetes¶

Readiness Probe¶

The readiness probe is a vital configuration for deployments in Kubernetes as it governs the routing logic. The requests will not be routed to a pod that is not ready.

Add the following configurations to your deployment.yaml file in order to configure the readiness probe for the server. Initial delay and the period has to be fine-tuned according to your deployment.

readinessProbe:
  httpGet:
    path: /healthz
    port: 9201
  initialDelaySeconds: 3
  periodSeconds: 1

Note

If you are running the server instance with a different port offset other than the default, which is 10, the health check API will serve at 9191 + offset.

Liveness Probe¶

The liveness probe is a primary configuration in Kubernetes since it is used for knowing when to restart a container. For example, if the server stops serving requests on the http port, even though the server is alive, the container needs to be restarted so that the Micro Integrator instances serve the requests flawlessly. The default http socket of WSO2 Micro Integrator can be used to health check for liveness.

Add the following configurations to your deployment.yaml file in order to configure the liveness probe for the server. Initial delay and the period will have to be fine-tuned according to your deployment.

livenessProbe:
  tcpSocket:
    port: 8290
  initialDelaySeconds: 15
  periodSeconds: 5

Note

If you are running the server instance with a different port offset other than the default, which is 10, the health check API will serve at 8280 + offset.

Top