-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Docs: Enable metrics in manifest-based deployments. #13171
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
Docs: Enable metrics in manifest-based deployments. #13171
Conversation
|
Welcome @piperubio! |
Hi @piperubio. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
✅ Deploy Preview for kubernetes-ingress-nginx ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please sign the CLA and apply the suggestions (or elaborate on why we need these characters) to get this PR merged. Thank you!
/retitle Docs: Enable metrics in manifest-based deployments.
/triage accepted
/kind documentation
/priority backlog
/hold
Hi @Gacko , Thank you for your suggestions. The Contributor License Agreement (CLA) has already been signed. Regarding the dots (...) in the code snippet, they are intentionally left to indicate that existing arguments should remain unchanged. For clarity—especially for less experienced users—it’s important to highlight that the monitoring argument should be appended to the existing list, not used as a replacement. I sincerely apologize for the delayed response. I was disappointed to see that the pull request I submitted was closed, particularly since no alternative update to the monitoring documentation has been made by the maintainers, nor has a follow-up pull request been opened to address this addition. I still believe this change would be helpful to users deploying with raw manifests. |
You can still re-open or re-create it. I closed it because I didn't receive any feedback. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/triage accepted
/kind documentation
/priority backlog
/lgtm
/cherry-pick release-1.12 |
@Gacko: once the present PR merges, I will cherry-pick it on top of In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/cherry-pick release-1.11 |
@Gacko: once the present PR merges, I will cherry-pick it on top of In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/unhold |
Add enable-metrics to true in Deployment manifest for deployment without helm
9f24108
to
547c753
Compare
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Gacko, piperubio The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@Gacko: new pull request created: #13235 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
@Gacko: new pull request created: #13236 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
What this PR does / why we need it:
This pull request improves the
monitoring.md
documentation by explicitly showing how to enable Prometheus metrics when deploying ingress-nginx using raw manifests.Currently, the documentation only shows how to expose the Prometheus metrics port (
10254
) via theprometheus
named port in the Deployment manifest. However, it omits the required argument--enable-metrics=true
that actually enables nginx-specific metrics.Without this argument, Prometheus can successfully scrape the
/metrics
endpoint, but it will only retrieve default Go and process-level metrics — not the nginx-related metrics such as HTTP requests, connections, or response codes. Adding--enable-metrics=true
ensures that these nginx-specific metrics are computed and made available.This clarification is particularly important for users not deploying via Helm.
Types of changes
Which issue/s this PR fixes
No specific issue opened, but it addresses a documentation gap related to Prometheus monitoring setup.
How Has This Been Tested?
The changes were validated by deploying ingress-nginx using the official manifests and confirming that Prometheus was able to scrape and display nginx-specific metrics from the exposed port 10254 after setting
--enable-metrics=true
.Checklist: