feat: Fine-tune logs presentation (#6771)

mtojek · web-flow · commit c9cbc63cd481 · 2023-03-24T13:29:18.000+01:00
* Process debug mode logs

* Debug logs are grey

* Fix
diff --git a/coderd/provisionerjobs.go b/coderd/provisionerjobs.go
@@ -347,7 +347,8 @@ func (api *API) followProvisionerJobLogs(actor rbac.Subject, jobID uuid.UUID) (<
 	logger := api.Logger.With(slog.F("job_id", jobID))
 
 	var (
-		bufferedLogs  = make(chan *database.ProvisionerJobLog, 128)
+		// With debug logging enabled length = 128 is insufficient
+		bufferedLogs  = make(chan *database.ProvisionerJobLog, 1024)
 		endOfLogs     atomic.Bool
 		lastSentLogID atomic.Int64
 	)
diff --git a/provisioner/terraform/executor.go b/provisioner/terraform/executor.go
@@ -460,7 +460,27 @@ func readAndLog(sink logSink, r io.Reader, done chan<- any, level proto.LogLevel
 	defer close(done)
 	scanner := bufio.NewScanner(r)
 	for scanner.Scan() {
-		sink.Log(&proto.Log{Level: level, Output: scanner.Text()})
+		var log terraformProvisionLog
+		err := json.Unmarshal(scanner.Bytes(), &log)
+		if err != nil {
+			if strings.TrimSpace(scanner.Text()) == "" {
+				continue
+			}
+
+			sink.Log(&proto.Log{Level: level, Output: scanner.Text()})
+			continue
+		}
+
+		logLevel := convertTerraformLogLevel(log.Level, sink)
+		if logLevel == proto.LogLevel_TRACE {
+			continue // skip TRACE log entries as they produce a lot of noise
+		}
+
+		// Degrade JSON log entries marked as INFO as these are logs produced in debug mode.
+		if logLevel == proto.LogLevel_INFO {
+			logLevel = proto.LogLevel_DEBUG
+		}
+		sink.Log(&proto.Log{Level: logLevel, Output: log.Message})
 	}
 }
 
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -236,6 +236,7 @@ func provisionEnv(config *proto.Provision_Config, params []*proto.ParameterValue
 	for _, gitAuth := range gitAuth {
 		env = append(env, provider.GitAuthAccessTokenEnvironmentVariable(gitAuth.Id)+"="+gitAuth.AccessToken)
 	}
+	// FIXME env = append(env, "TF_LOG=JSON")
 	return env, nil
 }
 
diff --git a/site/src/components/Logs/Logs.tsx b/site/src/components/Logs/Logs.tsx
@@ -108,7 +108,11 @@ const useStyles = makeStyles<
       backgroundColor: theme.palette.error.dark,
     },
 
-    "&.warning": {
+    "&.debug": {
+      backgroundColor: theme.palette.grey[900],
+    },
+
+    "&.warn": {
       backgroundColor: theme.palette.warning.dark,
     },
   },

Original file line number	Diff line number	Diff line change
`@@ -347,7 +347,8 @@ func (api *API) followProvisionerJobLogs(actor rbac.Subject, jobID uuid.UUID) (<`
`347`	`347`	`logger := api.Logger.With(slog.F("job_id", jobID))`
`348`	`348`
`349`	`349`	`var (`
`350`		`- bufferedLogs = make(chan *database.ProvisionerJobLog, 128)`
	`350`	`+ // With debug logging enabled length = 128 is insufficient`
	`351`	`+ bufferedLogs = make(chan *database.ProvisionerJobLog, 1024)`
`351`	`352`	`endOfLogs atomic.Bool`
`352`	`353`	`lastSentLogID atomic.Int64`
`353`	`354`	`)`
Original file line number	Diff line number	Diff line change
`@@ -236,6 +236,7 @@ func provisionEnv(config proto.Provision_Config, params []proto.ParameterValue`
`236`	`236`	`for _, gitAuth := range gitAuth {`
`237`	`237`	`env = append(env, provider.GitAuthAccessTokenEnvironmentVariable(gitAuth.Id)+"="+gitAuth.AccessToken)`
`238`	`238`	`}`
	`239`	`+ // FIXME env = append(env, "TF_LOG=JSON")`
`239`	`240`	`return env, nil`
`240`	`241`	`}`
`241`	`242`