Improve logging when disconnecting serial #62
Conversation
This file contains hidden or 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
An error that's propagated further shouldn't be logged using `error!` or `warn!`. The final consumer of the error can decide on the log message. The highest levels while the error is being propagated are `trace!` or `debug!`.
lukipuki
commented
Jul 18, 2025
| @@ -58,7 +58,7 @@ where | |||
| let mut buffer = [0u8; 1024]; | |||
| match read_stream.read(&mut buffer).await { | |||
| Ok(0) => { | |||
| warn!("read_stream has reached EOF"); | |||
| trace!("read_stream has reached EOF"); | |||
There was a problem hiding this comment.
I chose trace! here, as it exposes read_stream which is a variable name. Something that's not suitable for info or debug logs, only for trace.
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.
Summary
An error that's propagated further shouldn't be logged using
error!orwarn!. The final consumer of the error can decide on the log message. The highest levels while the error is being propagated aretrace!ordebug!.Related Issues
#27
Proposed Changes
Checklist