Skip to content

Health Checks on Services

If your application exposes health-check endpoints, you can define them when creating a service. UbiOps will use these checks to actively monitor the health of deployment instances in your service.

  • The service will wait for the application to become healthy before routing any traffic to it.
  • If the health check fails at any point, the service will immediately stop forwarding traffic.

A health check can be configured in the WebApp, using the API or via the Client Libraries or Command Line Interface. It has the following parameters:

  • path (string, required): The URL path to the health check endpoint (e.g., /health)
  • interval (integer, optional): The time in seconds between health checks
  • timeout (integer, optional): The time in seconds to wait for a response to the health check
  • failure threshold (integer, optional): The number of consecutive failures before marking the service as unhealthy. Defaults to 1.