mirror of
https://github.com/rustdesk/rustdesk.git
synced 2026-10-21 06:07:24 +00:00
docs(agents): avoid unthrottled high-frequency debug logs
Debug output is written to the log file, so per-packet / per-event log sites must use trace or hbb_common's throttled_log!. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
640fb32c3c
commit
c8a80ec74b
@@ -48,6 +48,20 @@ workspace member. `base::config::keys` re-exports the handful of keys
|
||||
* Do not add dependencies unless needed.
|
||||
* Keep code simple and idiomatic.
|
||||
|
||||
### Logging
|
||||
|
||||
* `debug` and above are written to the log file. A log call that can fire
|
||||
repeatedly (per packet, frame, input event, or loop iteration, or at a rate a
|
||||
peer controls) must not use `debug` or higher unthrottled.
|
||||
* For such a site, pick one:
|
||||
|
||||
* `log::trace!` when the event is expected and the line only helps while
|
||||
actively debugging;
|
||||
* `hbb_common::throttled_log!(interval, level, ...)` when it signals a fault
|
||||
that should still show up in a user's log. It keeps one line per interval
|
||||
with a count of the rest. Use `hbb_common::log_throttle::LogThrottle`
|
||||
directly only when the decision drives more than one log call.
|
||||
|
||||
## Tokio Rules
|
||||
|
||||
* Assume a Tokio runtime already exists.
|
||||
|
||||
Reference in New Issue
Block a user