Document and check metric config for gitlab-shell
requested to merge 3448-gitlab-shell-service-monitor-is-not-working-for-prometheus-connection-refused into master
What does this MR do?
Add docs and config check for gitlab-shell metrics
Metrics are only supported for "gitlab-shell" when "gitlab-sshd"
is used as the SSH daemon, as the OpenSSH daemon does not provide
viable collectable metrics.
Changelog: other
Related issues
Closes #3448 (closed)
Checklist
See Definition of done.
For anything in this list which will not be completed, please provide a reason in the MR discussion.
Test Plan
Running
helm template --set certmanager-issuer.email=test@example.com \
--set gitlab.gitlab-shell.metrics.enabled=true .
Should print a message stating that "openssh" as an SSH daemon doesn't support metrics.
Required
-
Merge Request Title and Description are up to date, accurate, and descriptive -
MR targeting the appropriate branch -
MR has a green pipeline on GitLab.com -
When ready for review, MR is labeled "~workflow::ready for review" per the Distribution MR workflow
Expected (please provide an explanation if not completing)
-
Test plan indicating conditions for success has been posted and passes -
Documentation created/updated -
Tests added -
Integration tests added to GitLab QA -
Equivalent MR/issue for omnibus-gitlab opened -
Validate potential values for new configuration settings. Formats such as integer10
, duration10s
, URIscheme://user:passwd@host:port
may require quotation or other special handling when rendered in a template and written to a configuration file.
Edited by Clemens Beck