Sidekiq health check
- Tier: Free, Premium, Ultimate
- Offering: GitLab 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"
}
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support