feat: Enable workspace debug logging #6838
Conversation
coderd/workspacebuilds_test.go
Outdated
| t.Parallel() | ||
|
|
||
| client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true}) | ||
| user := coderdtest.CreateFirstUser(t, client) |
There was a problem hiding this comment.
Blocking: instead of running this as the "admin" user, we should instead do as above and create another user with template admin permissions. This would more properly test that the template author has the correct permissions to create this sort of job.
There was a problem hiding this comment.
Thank you for the hint! Refactored.
| @@ -59,6 +65,8 @@ type CreateWorkspaceBuildRequest struct { | |||
| // This will not delete old params not included in this list. | |||
| ParameterValues []CreateParameterRequest `json:"parameter_values,omitempty"` | |||
| RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"` | |||
|
|
|||
| LogLevel ProvisionerLogLevel `json:"log_level,omitempty" validate:"omitempty,oneof=debug"` | |||
There was a problem hiding this comment.
suggestion: Add a comment so this gets documented in the API doc
| return response, true | ||
| } | ||
|
|
||
| provisionerLogLevel := proto.LogLevel_value[strings.ToUpper(config.ProvisionerLogLevel)] |
There was a problem hiding this comment.
Is there a way to avoid having to upper/lowercase this? Not blocking, just curious.
There was a problem hiding this comment.
I suppose that the only way to do this is to switch to log_level: DEBUG, so that it's upper-case everywhere. Not sure if it's worth it.
coderd/workspacebuilds_test.go
Outdated
| for { | ||
| log, ok := <-logs | ||
| if !ok { | ||
| break | ||
| } | ||
|
|
||
| if log.Output == "dont-want-it" { | ||
| require.Failf(t, "unexpected log message", "%s log message shouldn't be logged: %s", log.Level, log.Output) | ||
| } | ||
|
|
||
| if log.Output == "done" { | ||
| return | ||
| } | ||
| } |
There was a problem hiding this comment.
review: although it's in a naked for, this shouldn't hang forever as WorkspaceBuildLogsAfter exits on <-ctx.Done()
Related: #6186
Related: #4767
This PR enables workspace debug logging on the backend side.
TODO:
Tested:
mind the
"log_level":"debug"parameterFollow-up: