fix EXP-19: allow access to supervisor logs within a workspace (#18322)

Author: akosyakov

components/supervisor/cmd/init.go

@@ -30,8 +30,8 @@ var initCmd = &cobra.Command{
 	Use:   "init",
 	Short: "init the supervisor",
 	Run: func(cmd *cobra.Command, args []string) {
-		log.Init(ServiceName, Version, true, false)
-		log.Log.Logger.AddHook(fatalTerminationLogHook{})
+		logFile := initLog(true)
+		defer logFile.Close()
 
 		cfg, err := supervisor.GetConfig()
 		if err != nil {

components/supervisor/cmd/root.go

@@ -6,12 +6,15 @@ package cmd
 
 import (
 	"fmt"
+	"io"
 	"os"
+	"time"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
 	"github.com/gitpod-io/gitpod/common-go/log"
+	prefixed "github.com/x-cray/logrus-prefixed-formatter"
 )
 
 // rootCmd represents the base command when called without any subcommands.
@@ -52,3 +55,48 @@ func (fatalTerminationLogHook) Fire(e *logrus.Entry) error {
 
 	return os.WriteFile("/dev/termination-log", []byte(msg), 0o644)
 }
+
+const (
+	gitpodLogDir          = "/var/log/gitpod"
+	supervisorLogFilePath = gitpodLogDir + "/supervisor.log"
+)
+
+func initLog(json bool) io.Closer {
+	log.Init(ServiceName, Version, json, os.Getenv("SUPERVISOR_DEBUG_ENABLE") == "true")
+	log.Log.Logger.AddHook(fatalTerminationLogHook{})
+	if err := os.MkdirAll(gitpodLogDir, 0755); err != nil {
+		log.WithError(err).Error("cannot create gitpod log directory")
+		return io.NopCloser(nil)
+	}
+	supervisorLogFile, err := os.OpenFile(supervisorLogFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+	if err != nil {
+		log.WithError(err).Error("cannot open supervisor log file")
+		return io.NopCloser(nil)
+	}
+	log.Log.Logger.AddHook(&FileHook{
+		Writer: supervisorLogFile,
+		Formatter: &prefixed.TextFormatter{
+			TimestampFormat: time.RFC3339Nano,
+			FullTimestamp:   true,
+		},
+	})
+	return supervisorLogFile
+}
+
+type FileHook struct {
+	Writer    io.Writer
+	Formatter logrus.Formatter
+}
+
+func (hook *FileHook) Fire(entry *logrus.Entry) error {
+	formatted, err := hook.Formatter.Format(entry)
+	if err != nil {
+		return err
+	}
+	_, err = hook.Writer.Write(formatted)
+	return err
+}
+
+func (hook *FileHook) Levels() []logrus.Level {
+	return logrus.AllLevels
+}

components/supervisor/cmd/run.go

@@ -5,12 +5,9 @@
 package cmd
 
 import (
-	"os"
-
 	"github.com/spf13/cobra"
 
 	common_grpc "github.com/gitpod-io/gitpod/common-go/grpc"
-	"github.com/gitpod-io/gitpod/common-go/log"
 	"github.com/gitpod-io/gitpod/supervisor/pkg/supervisor"
 )
 
@@ -23,8 +20,8 @@ var runCmd = &cobra.Command{
 	Short: "starts the supervisor",
 
 	Run: func(cmd *cobra.Command, args []string) {
-		log.Init(ServiceName, Version, !runOpts.RunGP, os.Getenv("SUPERVISOR_DEBUG_ENABLE") == "true")
-		log.Log.Logger.AddHook(fatalTerminationLogHook{})
+		logFile := initLog(!runOpts.RunGP)
+		defer logFile.Close()
 
 		common_grpc.SetupLogging()
 		supervisor.Version = Version

components/supervisor/go.mod

@@ -44,6 +44,12 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require (
+	github.com/mattn/go-colorable v0.1.8 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
+)
+
 require (
 	github.com/gitpod-io/gitpod/components/scrubber v0.0.0-00010101000000-000000000000 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
@@ -131,6 +137,7 @@ require (
 	github.com/stretchr/testify v1.8.1 // indirect
 	github.com/uber/jaeger-client-go v2.29.1+incompatible // indirect
 	github.com/uber/jaeger-lib v2.4.1+incompatible // indirect
+	github.com/x-cray/logrus-prefixed-formatter v0.5.2
 	github.com/xtgo/uuid v0.0.0-20140804021211-a0b114877d4c // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.uber.org/atomic v1.4.0 // indirect