summaryrefslogtreecommitdiff
path: root/internal/logging/logger.go
blob: 569ad06e6ec9475f2d56eb9b5b4410db3d05e040 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
package logging

import (
	"fmt"
	"io"
	"os"

	logrus_stack "github.com/Gurpartap/logrus-stack"
	"github.com/sirupsen/logrus"

	"github.com/authelia/authelia/v4/internal/configuration/schema"
)

// Logger returns the standard logrus logger.
func Logger() *logrus.Logger {
	return logrus.StandardLogger()
}

// InitializeLogger configures the default logger similar to ConfigureLogger but also configures the stack levels hook.
func InitializeLogger(config schema.Log, log bool) (err error) {
	initializeStackTracer(config)

	return ConfigureLogger(config, log)
}

func initializeStackTracer(config schema.Log) {
	// Ensure the stack trace hook is only initialized once.
	stacktrace.Do(func() {
		var (
			callerLevels, stackLevels []logrus.Level
		)

		switch LogLevel(config.Level).Level() {
		case logrus.DebugLevel:
			stackLevels = []logrus.Level{logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel}
		case logrus.TraceLevel:
			stackLevels = []logrus.Level{logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel}
			callerLevels = logrus.AllLevels
		default:
			stackLevels = []logrus.Level{logrus.PanicLevel, logrus.FatalLevel}
		}

		logrus.AddHook(logrus_stack.NewHook(callerLevels, stackLevels))
	})
}

// ConfigureLogger configures the default loggers level, formatting, and the output destinations.
func ConfigureLogger(config schema.Log, log bool) (err error) {
	setLevelStr(config.Level, log)

	switch config.Format {
	case FormatJSON:
		logrus.SetFormatter(&logrus.JSONFormatter{})
	default:
		logrus.SetFormatter(&logrus.TextFormatter{})
	}

	var writers []io.Writer

	switch {
	case config.FilePath != "":
		lf = NewFile(config.FilePath)

		if err = lf.Open(); err != nil {
			return err
		}

		if config.Format != FormatJSON {
			logrus.SetFormatter(&logrus.TextFormatter{
				DisableColors: true,
				FullTimestamp: true,
			})
		}

		writers = []io.Writer{lf}

		if config.KeepStdout {
			writers = append(writers, os.Stdout)
		}
	default:
		writers = []io.Writer{os.Stdout}
	}

	logrus.SetOutput(io.MultiWriter(writers...))

	return nil
}

// Reopen handles safely reopening the log file.
func Reopen() (err error) {
	if lf == nil {
		return fmt.Errorf("error reopening log file: file is not configured or open")
	}

	return lf.Reopen()
}

func setLevelStr(level string, log bool) {
	logrus.SetLevel(LogLevel(level).Level())

	if log {
		logrus.Infof("Log severity set to %s", level)
	}
}