summaryrefslogtreecommitdiff
path: root/plugins/logger/zap_logger.go
blob: e1986da3f2d90a4e5371d37e2df064d97013d449 (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
package logger

import (
	"github.com/spiral/endure"
	"github.com/spiral/roadrunner/v2/plugins/config"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

// ServiceName declares service name.
const ServiceName = "logs"

type LogFactory interface {
	// GlobalLogger returns global log instance.
	GlobalLogger() *zap.Logger

	// NamedLogger returns logger dedicated to the specific channel. Similar to Named() but also reads the core params.
	NamedLogger(name string) *zap.Logger
}

// ZapLogger manages zap logger.
type ZapLogger struct {
	base *zap.Logger
	cfg  Config
}

func (z *ZapLogger) Init(cfg config.Provider) (err error) {
	err = cfg.UnmarshalKey(ServiceName, &z.cfg)
	if err != nil {
		return err
	}

	if z.base == nil {
		cfg := zap.Config{
			Level:    zap.NewAtomicLevelAt(zap.DebugLevel),
			Encoding: "console",
			EncoderConfig: zapcore.EncoderConfig{
				MessageKey:   "message",
				LevelKey:     "level",
				TimeKey:      "time",
				NameKey:      "name",
				EncodeName:   ColoredHashedNameEncoder,
				EncodeLevel:  ColoredLevelEncoder,
				EncodeTime:   UTCTimeEncoder,
				EncodeCaller: zapcore.ShortCallerEncoder,
			},
			OutputPaths:      []string{"stderr"},
			ErrorOutputPaths: []string{"stderr"},
		}

		z.base, err = cfg.Build()
		if err != nil {
			return err
		}
	}

	return nil
}

// GlobalLogger returns global log instance.
func (z *ZapLogger) GlobalLogger() *zap.Logger {
	return z.base
}

// NamedLogger returns logger dedicated to the specific channel. Similar to Named() but also reads the core params.
func (z *ZapLogger) NamedLogger(name string) *zap.Logger {
	// todo: automatically configure
	return z.base.Named(name)
}

// Provides declares factory methods.
func (z *ZapLogger) Provides() []interface{} {
	return []interface{}{
		z.DefaultLogger,
		z.AllocateLogger,
	}
}

// AllocateLogger allocates logger for the service.
func (z *ZapLogger) AllocateLogger(n endure.Named) (*zap.Logger, error) {
	return z.NamedLogger(n.Name()), nil
}

// DefaultLogger returns default logger.
func (z *ZapLogger) DefaultLogger() (*zap.Logger, error) {
	return z.GlobalLogger(), nil
}