logging: clarify error logging #8686
Open
+23
−2
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
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
area/developer-guide
pohly
force-pushed
the
error-logging
branch
3 times, most recently
from
5b58828 to
d9ad77a
Compare
The main purpose of error logging is informing admins about problems. Our logging libraries are not configured to log additional debug information for errors. Producing an error log before returning an error is usually wrong. runtime.HandleErrorWithContext and runtime.HandleErrorWithLogger were not mentioned even though they are meant to be used in certain places.
Contributor
Author
|
/assign @deads2k |
deads2k
reviewed
Nov 17, 2025
Comment on lines
+79
to
+81
| Whenever possible, use this instead of normal error logging at the top of a call chain, i.e. the place where code | ||
| cannot return an error up to its caller, if there is no other way of handling the error (like logging it | ||
| and then exiting the process). |
Contributor
There was a problem hiding this comment.
Great advice, thanks.
lgtm. I'll leave it open for others to comment, but if it's still open in a week or two remind me and I'll tag for merge.
Contributor
Author
dashpole
approved these changes
Nov 17, 2025
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dashpole, pohly The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The main purpose of error logging is informing admins about problems. Our logging libraries are not configured to log additional debug information for errors.
Producing an error log before returning an error is usually wrong.
runtime.HandleErrorWithContext and runtime.HandleErrorWithLogger were not mentioned even though they are meant to be used in some places.