Skip to content

Document Sidekiq health-check config keys

Before #345804 (closed) is done and since for SaaS we are already using the new settings keys for health-checks, we should document them publicly.

Together with #347509 (closed) we should prepare customers to use these new keys (if necessary) and describe how.

Omnibus

This might requires changes in multiple places.

We now have:

# Sidekiq metrics server defaults
default['gitlab']['sidekiq']['metrics_enabled'] = true
default['gitlab']['sidekiq']['exporter_log_enabled'] = false
default['gitlab']['sidekiq']['listen_address'] = "127.0.0.1"
default['gitlab']['sidekiq']['listen_port'] = 8082

and

# Sidekiq health-check server defaults
default['gitlab']['sidekiq']['health_checks_enabled'] = nil
default['gitlab']['sidekiq']['health_checks_log_enabled'] = nil
default['gitlab']['sidekiq']['health_checks_listen_address'] = nil
default['gitlab']['sidekiq']['health_checks_listen_port'] = nil

We should explain the difference between the two, and when they should be used. Configuring health_checks in Omnibus is only necessary if there is something that actually probes them.

https://docs.gitlab.com/ee/administration/sidekiq.html

Links:

Charts

We need to document the new setting in the sidekiq chart values:

health_checks:
  enabled: true
  port: 1234

https://docs.gitlab.com/charts/charts/gitlab/sidekiq

Links:

Edited by Matthias Käppler