docs(prometheus): metric name should include aws_ prefix #4443
+4
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
docs/guide/metrics/prometheus/index.mdto correct four metric names:api_call_permission_errors_total→aws_api_call_permission_errors_totalapi_call_service_limit_exceeded_errors_total→aws_api_call_service_limit_exceeded_errors_totalapi_call_throttled_errors_total→aws_api_call_throttled_errors_totalapi_call_validation_errors_total→aws_api_call_validation_errors_totalWhy 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 theaws_subsystem prefix as defined inpkg/metrics/aws/instruments.go. This fix aligns the documentation with the actual implementation.Checklist
README.md, or thedocsdirectory)BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯