-
Notifications
You must be signed in to change notification settings - Fork 904
fix: provisionerd: add more context to logs emitted, fix log level #6508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This reverts commit d010b47.
@@ -895,8 +895,9 @@ func (r *Runner) buildWorkspace(ctx context.Context, stage string, req *sdkproto | |||
}) | |||
case *sdkproto.Provision_Response_Complete: | |||
if msgType.Complete.Error != "" { | |||
r.logger.Info(context.Background(), "provision failed; updating state", | |||
r.logger.Warn(context.Background(), "provision failed; updating state", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: logging at level ERROR breaks existing unit tests, and I don't want to set slogtest.IgnoreErrors
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Understandable. It might be the "correct" approach though, if we expect errors to be logged, then setting IgnoreErrors seems like the right course of action.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mafredri Would you agree that anything "ERROR" and above should be mainly for events useful to a system administrator?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could be relevant for e.g. template authors, but generally I doubt coder/provisioner logs (via logger) would be surfaced to anyone but systems admins.
case sdkproto.LogLevel_ERROR: | ||
r.logger.Error(ctx, msg, fields...) | ||
default: // should never happen, but we should not explode either. | ||
r.logger.Info(ctx, msg, fields...) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In theory, it could be possible that a customer misconfigures the Coder deployment, INFO will be selected as default logging level, and it can blow up the cluster if there are thousands of logs, but that's just theory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
INFO is the status quo, and the only way for someone to select a different level is to set CODER_VERBOSE
or --verbose
, both of which need to be set explicitly.
ERRORWARN and including theerror
field in the message.