Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

metrics: Disable prometheus metrics by default #31144

Merged
merged 1 commit into from Mar 6, 2024

Conversation

joestringer
Copy link
Member

@joestringer joestringer commented Mar 4, 2024

Prior to commit c49ef45, the prometheus metrics server was
disabled by default in Cilium. Typically we would expect users to
specify in helm both prometheus.enabled and prometheus.port to
determine how to configure the prometheus server to ensure that the
prometheus port doesn't also conflict with other services that the user
is running on their nodes in their clusters.

With the refactor in the aforementioned commit, the default was set to
:9962. This means that even if the user installed Cilium without
prometheus settings, or explicitly configured helm with
prometheus.enabled: false, the prometheus metrics server would be
enabled. There is no way to turn it off via Helm currently.

This patch reverts the default back to the pre-v1.14 default.

Fixes: c49ef45 ("metrics: Modularize daemon metrics registry")
Fixes: #31135

@joestringer joestringer added release-note/bug This PR fixes an issue in a previous release of Cilium. affects/v1.14 This issue affects v1.14 branch affects/v1.15 This issue affects v1.15 branch needs-backport/1.15 This PR / issue needs backporting to the v1.15 branch labels Mar 4, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.15.2 Mar 4, 2024
@joestringer
Copy link
Member Author

/test

Prior to commit c49ef45, the prometheus metrics server was
disabled by default in Cilium. Typically we would expect users to
specify in helm both `prometheus.enabled` and `prometheus.port` to
determine how to configure the prometheus server to ensure that the
prometheus port doesn't also conflict with other services that the user
is running on their nodes in their clusters.

With the refactor in the aforementioned commit, the default was set to
`:9962`. This means that even if the user installed Cilium without
prometheus settings, or explicitly configured helm with
`prometheus.enabled: false`, the prometheus metrics server would be
enabled.

This patch reverts the default back to the pre-v1.14 default.

Fixes: c49ef45 ("metrics: Modularize daemon metrics registry")
Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer
Copy link
Member Author

/test

@joestringer joestringer marked this pull request as ready for review March 5, 2024 22:08
@joestringer joestringer requested a review from a team as a code owner March 5, 2024 22:08
@joestringer joestringer requested a review from chancez March 5, 2024 22:08
Copy link
Contributor

@chancez chancez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, the default port is still configured in the helm values, gated by prometheus.enabled so this does look like it should fix the problem and retain compatibility on the helm side as well.

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Mar 6, 2024
@joestringer joestringer added this pull request to the merge queue Mar 6, 2024
Merged via the queue into main with commit f31cbef Mar 6, 2024
220 checks passed
@joestringer joestringer deleted the pr/joe/metrics-default branch March 6, 2024 19:14
@jibi jibi mentioned this pull request Mar 12, 2024
16 tasks
@jibi jibi added backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. and removed needs-backport/1.15 This PR / issue needs backporting to the v1.15 branch labels Mar 12, 2024
@jrajahalme jrajahalme removed this from Needs backport from main in 1.15.2 Mar 13, 2024
@jibi jibi added needs-backport/1.15 This PR / issue needs backporting to the v1.15 branch and removed backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. labels Mar 13, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.15.2 Mar 13, 2024
@jrajahalme jrajahalme added this to Needs backport from main in 1.15.3 Mar 13, 2024
@jrajahalme jrajahalme removed this from Needs backport from main in 1.15.2 Mar 13, 2024
@jibi jibi added backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. and removed needs-backport/1.15 This PR / issue needs backporting to the v1.15 branch labels Mar 13, 2024
@github-actions github-actions bot added backport-done/1.15 The backport for Cilium 1.15.x for this PR is done. and removed backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. labels Mar 16, 2024
@jrajahalme jrajahalme moved this from Needs backport from main to Backport done to v1.15 in 1.15.3 Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects/v1.14 This issue affects v1.14 branch affects/v1.15 This issue affects v1.15 branch backport-done/1.15 The backport for Cilium 1.15.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/bug This PR fixes an issue in a previous release of Cilium.
Projects
No open projects
1.15.3
Backport done to v1.15
Development

Successfully merging this pull request may close these issues.

Prometheus metrics enabled by default | how to disable them
3 participants