Move cmd/common to shared (#3092)

2025-09-03 02:39:01 +00:00 · 2023-12-31 23:29:56 +01:00
parent 4b977ab488
commit 0c05c38ddd
9 changed files with 19 additions and 19 deletions
--- a/shared/logger/logger.go
+++ b/shared/logger/logger.go
@@ -0,0 +1,102 @@
+// Copyright 2023 Woodpecker Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package logger
+
+import (
+	"io"
+	"os"
+
+	"github.com/6543/logfile-open"
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/urfave/cli/v2"
+)
+
+var GlobalLoggerFlags = []cli.Flag{
+	&cli.StringFlag{
+		EnvVars: []string{"WOODPECKER_LOG_LEVEL"},
+		Name:    "log-level",
+		Usage:   "set logging level",
+		Value:   "info",
+	},
+	&cli.StringFlag{
+		EnvVars: []string{"WOODPECKER_LOG_FILE"},
+		Name:    "log-file",
+		Usage:   "Output destination for logs. 'stdout' and 'stderr' can be used as special keywords.",
+		Value:   "stderr",
+	},
+	&cli.BoolFlag{
+		EnvVars: []string{"WOODPECKER_DEBUG_PRETTY"},
+		Name:    "pretty",
+		Usage:   "enable pretty-printed debug output",
+		Value:   isInteractiveTerminal(), // make pretty on interactive terminal by default
+	},
+	&cli.BoolFlag{
+		EnvVars: []string{"WOODPECKER_DEBUG_NOCOLOR"},
+		Name:    "nocolor",
+		Usage:   "disable colored debug output, only has effect if pretty output is set too",
+		Value:   !isInteractiveTerminal(), // do color on interactive terminal by default
+	},
+}
+
+func SetupGlobalLogger(c *cli.Context, printLvl bool) {
+	logLevel := c.String("log-level")
+	pretty := c.Bool("pretty")
+	noColor := c.Bool("nocolor")
+	logFile := c.String("log-file")
+
+	var file io.ReadWriteCloser
+	switch logFile {
+	case "", "stderr": // default case
+		file = os.Stderr
+	case "stdout":
+		file = os.Stdout
+	default: // a file was set
+		openFile, err := logfile.OpenFileWithContext(c.Context, logFile, 0o660)
+		if err != nil {
+			log.Fatal().Err(err).Msgf("could not open log file '%s'", logFile)
+		}
+		file = openFile
+		noColor = true
+	}
+
+	log.Logger = zerolog.New(file).With().Timestamp().Logger()
+
+	if pretty {
+		log.Logger = log.Output(
+			zerolog.ConsoleWriter{
+				Out:     file,
+				NoColor: noColor,
+			},
+		)
+	}
+
+	// TODO: format output & options to switch to json aka. option to add channels to send logs to
+
+	lvl, err := zerolog.ParseLevel(logLevel)
+	if err != nil {
+		log.Fatal().Msgf("unknown logging level: %s", logLevel)
+	}
+	zerolog.SetGlobalLevel(lvl)
+
+	// if debug or trace also log the caller
+	if zerolog.GlobalLevel() <= zerolog.DebugLevel {
+		log.Logger = log.With().Caller().Logger()
+	}
+
+	if printLvl {
+		log.Info().Msgf("LogLevel = %s", zerolog.GlobalLevel().String())
+	}
+}