Option to debounce log messages
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 36.9k
- Forks
- 5.2k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 713
Description
How to use GitHub
- Please use the 👍 reaction to show that you are interested into the same feature.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
As a Nextcloud developer, I sometimes want to log a message, but refrain from it because it happens on a frequently executed spot, so it would spam the logs.
Describe the solution you'd like
Allow me to debounce a log message, so it only shows once per x seconds.
$this->logger->debug("This is an annoying deprecation log message", ["debounce" => 60]);
Debouncing can be done with a local low latency cache like APCu.
Describe alternatives you've considered
N/a
Additional context
N/a
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 is named. Start by tracing the PHP logger->debug entry point and reviewing how APCu could support the requested per-message interval; done should mean a log message with a debounce interval appears at most once per that many seconds without changing ordinary logging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100