[Chore][Log] Delete error loggings right before returned errors #2103
Conversation
This file contains 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
MortalHappiness
force-pushed
the
feature/delete-error-log-before-return
branch
from
a4249e8 to
542abfa
Compare
andrewsykim
reviewed
Apr 30, 2024
| @@ -925,7 +920,6 @@ func (r *RayClusterReconciler) createHeadIngress(ctx context.Context, ingress *n | |||
| logger.Info("Ingress already exists, no need to create") | |||
| return nil | |||
| } | |||
| logger.Error(err, "Ingress create error!", "Ingress.Error", err) | |||
There was a problem hiding this comment.
Agreed it's redundant to both log and return an error. Wondering if we should at least wrap the errors though for better debugability:
return fmt.Errorf("error creating ingress: %w, err")
542abfa to
0ce67f3
Compare
MortalHappiness
force-pushed
the
feature/delete-error-log-before-return
branch
from
0ce67f3 to
6cdc87d
Compare
Signed-off-by: Chi-Sheng Liu <[email protected]>
MortalHappiness
force-pushed
the
feature/delete-error-log-before-return
branch
from
6cdc87d to
f6d07e0
Compare
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.
Why are these changes needed?
Based on the What not to Log section in the logging guidelines, we should not log errors inside functions that return errors.
Therefore, in this PR all error loggings right before the returned errors are deleted.
Related issue number
N/A
Checks