Sidekiq Health Check

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

Assuming you set up Sidekiq’s address and port to be localhost and 8092 respectively, here’s an example request:

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

Assuming you set up Sidekiq’s address and port to be localhost and 8092 respectively, here’s an example request:

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

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

{
   "status": "ok"
}