Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.51 KB

sidekiq_health_check.md

File metadata and controls

62 lines (44 loc) · 1.51 KB
stage group info
Systems
Distribution
To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments

Sidekiq health check

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

GitLab provides liveness and readiness probes to indicate service health and reachability to the Sidekiq cluster. These endpoints can be provided to schedulers like Kubernetes to hold traffic until the system is ready or restart the container as needed.

The health check server can be set up when configuring Sidekiq.

Readiness

The readiness probe checks whether the Sidekiq workers are ready to process jobs.

GET /readiness

If the server is bound to localhost:8092, the process cluster can be probed for readiness as follows:

curl "http://localhost:8092/readiness"

On success, the endpoint returns a 200 HTTP status code, and a response like the following:

{
   "status": "ok"
}

Liveness

Checks whether the Sidekiq cluster is running.

GET /liveness

If the server is bound to localhost:8092, the process cluster can be probed for liveness as follows:

curl "http://localhost:8092/liveness"

On success, the endpoint returns a 200 HTTP status code, and a response like the following:

{
   "status": "ok"
}