Added description to list of metrics reported by cni-metrics-helper #2786
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
In #2421 (comment) there was an ask of providing a description of "how to use [the metrics] to monitor the health of the cluster." I think the description of each metric also satisfies this, but please let me know if it doesn't |
jdn5126
reviewed
Feb 6, 2024
There was a problem hiding this comment.
This is a great start, thanks @zachdorame! I believe the full list of metrics we support can be found at https://github.com/aws/amazon-vpc-cni-k8s/blob/master/cmd/cni-metrics-helper/metrics/cni_metrics.go#L30
jdn5126
reviewed
Feb 6, 2024
jdn5126
reviewed
Feb 12, 2024
jdn5126
approved these changes
Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
documentation
Which issue does this PR fix:
#2421
What does this PR do / Why do we need it:
This PR provides a description of each metric reported by
cni-metrics-helper. It consolidates both the metric name and metric description into a table.If an issue # is not available please add repro steps and logs from IPAMD/CNI showing the issue:
Testing done on this change:
N/A
Will this PR introduce any new dependencies?:
No
Will this break upgrades or downgrades? Has updating a running cluster been tested?:
No, No
Does this change require updates to the CNI daemonset config files to work?:
No
Does this PR introduce any user-facing change?:
No
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.