Skip to content

Document ACK metrics #2028

@csantanapr

Description

@csantanapr

I was informed that the ACK controllers emit prometheus metrics, I think documentation is missing for this topic

Information to provide

  • Path and port to collect metrics from controllers
  • List the metrics available in categories, some will be from controller-runtime, some will be ACK specific
  • Describe what this metrics are and how to use them to monitor the health of the controllers
  • (Optional) Provide a generic Grafana dashboard that illustrate how to visualize this metrics properly, the important thing here is that it will provide promQl sample queries
  • Link to the soak test from the project as a reference implementation on how to use the metrics when end users are going to update the controller, they can run a soak test in a staging environment before upgrading ACK controller in production

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationIssues or PRs related to documentation and exampleshelp wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/enhancementCategorizes issue or PR as related to existing feature enhancements.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions