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

Integrate Prometheus Exporter #761

Closed
Tracked by #620
mpstefan opened this issue Jun 15, 2023 · 2 comments · Fixed by #999
Closed
Tracked by #620

Integrate Prometheus Exporter #761

mpstefan opened this issue Jun 15, 2023 · 2 comments · Fixed by #999
Assignees
Labels
enhancement New feature or request refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Milestone

Comments

@mpstefan
Copy link
Collaborator

mpstefan commented Jun 15, 2023

As an operator of NKG in a production environment
I want Prometheus metrics to be exposed for NKG
So that I can observe and monitor the performance of NKG and respond to incidents.

Acceptance

  • Prometheus Exporter is integrated with NKG
  • NGINX and NKG Controller runtime metrics are exposed through the Prometheus endpoint
  • Configurable port for the metrics endpoint
  • Annotations are present in the deployment manifest for NKG to make the Prometheus endpoint discoverable
  • Documentation is added that includes a list of metrics we provide
  • Our architecture document is updated to include the traffic for Prometheus.
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. enhancement New feature or request labels Jun 15, 2023
@sjberman
Copy link
Contributor

sjberman commented Jun 15, 2023

Something to think about is how does a user configure the metrics port? CLI argument? Do we need a custom CRD for NKG-specific configuration? Thinking ahead to when we support tracing, there are quite a few configurables. Might be worth planning this out now.

I'll note that the CRD is likely for mutable runtime fields. Metrics port may not be something we can change at runtime, so CLI argument may make more sense for that.

@mpstefan mpstefan removed the refined Requirements are refined and the issue is ready to be implemented. label Jun 16, 2023
@mpstefan mpstefan added this to the v0.6.0 milestone Jun 21, 2023
@mpstefan
Copy link
Collaborator Author

Briefly talked about likely needing to control the metrics port via a CLI argument.

@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Jul 17, 2023
@mpstefan mpstefan added the size/medium Estimated to be completed within a week label Aug 9, 2023
@sjberman sjberman assigned sjberman and unassigned sjberman Aug 9, 2023
@ciarams87 ciarams87 self-assigned this Aug 16, 2023
@mpstefan mpstefan mentioned this issue Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants