Skip to content

Conversation

@samuelmasuy
Copy link
Contributor

Issue

No existing issue - documentation bug fix

Description

This PR fixes incorrect metric names in the Prometheus metrics documentation. The error metrics were documented without the aws_ subsystem prefix, causing confusion when users tried to query these metrics.

Changes:

  • Updated docs/guide/metrics/prometheus/index.md to correct four metric names:
    • api_call_permission_errors_totalaws_api_call_permission_errors_total
    • api_call_service_limit_exceeded_errors_totalaws_api_call_service_limit_exceeded_errors_total
    • api_call_throttled_errors_totalaws_api_call_throttled_errors_total
    • api_call_validation_errors_totalaws_api_call_validation_errors_total

Why this matters:
When users queried Prometheus using the documented metric names (without aws_ prefix), they received no results. The actual metrics exported by the controller include the aws_ subsystem prefix as defined in pkg/metrics/aws/instruments.go. This fix aligns the documentation with the actual implementation.

Checklist

  • Added tests that cover your change (if possible) - N/A for documentation fix
  • Added/modified documentation as required (such as the README.md, or the docs directory)
  • Manually tested - verified metric names match actual Prometheus output
  • Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯

  • Backfilled missing tests for code in same general area 🎉
  • Refactored something and made the world a better place 🌟

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 12, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: samuelmasuy
Once this PR has been reviewed and has the lgtm label, please assign shraddhabang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 12, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @samuelmasuy. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 12, 2025
@samuelmasuy samuelmasuy changed the title docs(prometheus): fix metric names to include aws_ prefix for error m… docs(prometheus): metric name should include aws_ prefix Nov 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants