Add external API calls metric #385
Merged
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
mergenci
requested review from
ulucinar,
sergenyalcin and
erhancagirici
as code owners
ulucinar
reviewed
Mar 28, 2024
There was a problem hiding this comment.
Thank you @mergenci, left some comments to discuss.
Maybe we should also warn the provider developers regarding the dangers of high cardinality, which may adversely affect the performance of the monitoring system if the provider has a very large number of observed service,operation pairs. I think such a warning would be suitable in the doc comments of the metrics.ExternalAPICalls counter.
Signed-off-by: Cem Mergenci <[email protected]>
mergenci
force-pushed
the
external-api-calls-metric
branch
from
864d2aa
to
5f977ad
Compare
|
Thanks for your contributions @ulucinar 🙏 |
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.
Description of your changes
Add a metric to count the number of external API calls, so that provider users can monitor their API call rate. Doing so is essential in addressing rate limiting concerns.
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
In my
provider-upjet-awscode I called,metrics.ExternalAPICalls.WithLabelValues("myService", "myOperation").Inc(). I observed the effect by visitinglocalhost:8080/metrics, which is the provider's Prometheus metrics endpoint.