Deprecate prometheus enable and listen_address in gitlab.yml
Background:
Per #30175 (comment 372264754)
The naming of the setting
prometheus.listen_address
ingitlab.yml
is confusing. This is not a "listen address", but essentially where Rails should go look for a Prometheus instance. It might be better if we make it justprometheus.address
orprometheus.server_address
or something like that. This will need a deprecation process.
We do not need prometheus.enable
in gitlab.yml
, either. Because:
- it talks only about bundled Prometheus
- if
prometheus.server_address
present, it tells us the available Prometheus server, no matter external or bundled. So it does not tell use any more information, simplyprometheus.enable == prometheus.server_address.present?
As the first step, #30175 (closed) introduces prometheus.server_address
in gitlab.yml. That should be the SSOT. And it currently maintains the value of prometheus.enable
and prometheus.listen_address
in gitlab.yml.
This issue:
The next step is to deprecate prometheus.enable
and prometheus.listen_address
in gitlab.yml.
- Remove the usage of
prometheus.enable
andprometheus.listen_address
from existing source code. Useserver_address
instead.- Do we need to fall back to
listen_address
ifserver_address
is not available? I thinkserver_address
will always be available after omnibus-gitlab!4309 (merged). Is there any chance users can use the new version GitLab source code(where we only useserver_address
) with old versiongitlab.yml
(whereserver_address
is not there)?
- Do we need to fall back to
- Change the document? (is there?)