vectordotdev / vectordotdev/vector
Cleanup rate limit messaging
Open
Nobody has claimed this yet.
domain: observability
have: should
- Dominant language
- Rust
- Stars
- 22.6k
- Forks
- 2.3k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 146
Description
Related https://github.com/timberio/vector/issues/989
Currently when an event is rate limited it produces the following logs:
INFO basic: hello, world! count=0 rate_limit_secs=5
INFO basic: "hello, world!" is being rate limited. rate_limit_secs=5
...5 seconds pass...
INFO basic: 5 "hello, world!" events were rate limited. rate_limit_secs=5
We should clean these up to produce:
INFO basic: hello, world!
INFO basic: "hello, world!" is being rate limited for 5 seconds.
...5 seconds pass...
INFO basic: "hello, world!" was rate-limited for 5 seconds and was received 54 times.
- The
count=0 and rate_limit_secs=5have been removed. - The second and third events are only displayed if an event was received. Otherwise, the user is non-the-wiser to the fact that the event would be rate-limited.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test path is named in the issue. Start by locating the rate-limit logging that produces the shown messages, then compare its output and emission conditions with the requested examples. Done means removing the extra fields, reporting the duration and count in the new wording, and suppressing the latter messages when no event was received.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- observability
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100