logp: add rate limited logger #256
Draft
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
This commit adds support for rate limiting to logp.Logger. This is useful
when you have a lot of log messages and you want to avoid flooding the
destination.
The logger was augmented with the following methods:
`Throttled` will only log once every period.
`Sampled` will only log the nth message.
`Limited` will only log the first n messages.
The implementation is based on x/time/rate.Sometimes.
For all these limiters any message that is not logged will be dropped.
These also synergize with one another, for example:
log.Sampled(10).
Throttled(time.Second).
Info("")`
will log one message every second, and only one out of ten messages.
Likewise,
log.Limited(10).
Throttled(time.Second).
Info("")
will log the first ten messages, and then one message every second.
mauri870
requested review from
faec and
VihasMakwana
and removed request for
a team
6 tasks
mauri870
commented
Nov 29, 2024
pierrehilbert
added
the
Team:Elastic-Agent-Data-Plane
💚 Build Succeeded
History
cc @mauri870 |
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 does this PR do?
This commit adds support for rate limiting to logp.Logger. This is useful
when you have a lot of log messages and you want to avoid flooding the
destination.
The logger was augmented with the following methods:
Throttledwill only log once every period.Sampledwill only log the nth message.Limitedwill only log the first n messages.The implementation is based on x/time/rate.Sometimes.
For all these limiters any message that is not logged will be dropped.
These also synergize with one another, for example:
will log one message every second, and only one out of ten messages.
Likewise,
will log the first ten messages, and then one message every second.
Why is it important?
Checklist
Author's Checklist
Related issues