feat(metrics): log warning on empty metrics #1397
Merged
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
When using the
logMetrics
decorator or middleware users can pass athrowOnEmptyMetrics
parameter to set the Metrics utility to throw an error when metrics are being flushed but no metric is actually present. In those cases whenthrowOnEmptyMetrics
is set tofalse
and no metric is added however the utility "fails silently" giving the user no way of detecting potentially missing metrics.This PR introduces a new warning log that reads:
This warning will be logged whenever the user tries to flush metrics but no metric was stored and
throwOnEmptyMetrics
is set tofalse
or not set.Once merged this PR closes #1291.
Related issues, RFCs
Issue number: #1291
Checklist
Breaking change checklist
Is it a breaking change?: NO
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.