-
Notifications
You must be signed in to change notification settings - Fork 1
/
logging.go
135 lines (119 loc) · 3.9 KB
/
logging.go
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
* Copyright 2022 Armory, Inc.
*
* 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 logging
import (
"github.com/armory-io/go-commons/metadata"
"go.uber.org/fx"
"go.uber.org/fx/fxevent"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"os"
"strings"
)
const (
applicationName = "service.name"
version = "version"
environment = "environment"
replicaSet = "replicaset"
hostname = "hostname"
)
func ArmoryLoggerProvider(appMd metadata.ApplicationMetadata) (*zap.Logger, error) {
loggerOptions := armoryStdLogOpt()
level, err := zapcore.ParseLevel(appMd.LoggingLevel)
if err != nil {
level = zapcore.InfoLevel
}
switch strings.ToLower(appMd.LoggingType) {
case "json":
return createJSONLogger(appMd, loggerOptions)
case "console":
return createArmoryConsoleLogger(loggerOptions, level)
case "console-wide":
baseLogFields := getProductionLoggerFields(appMd)
loggerOptions = append(loggerOptions, zap.Fields(baseLogFields...))
return createArmoryConsoleLogger(loggerOptions, level)
default:
switch strings.ToLower(appMd.Environment) {
case "production", "prod", "staging", "stage":
return createJSONLogger(appMd, loggerOptions)
default:
return createArmoryConsoleLogger(loggerOptions, level)
}
}
}
func createJSONLogger(appMd metadata.ApplicationMetadata, loggerOptions []zap.Option) (*zap.Logger, error) {
baseLogFields := getProductionLoggerFields(appMd)
loggerOptions = append(loggerOptions, zap.Fields(baseLogFields...))
return zap.NewProductionConfig().Build(loggerOptions...)
}
func getProductionLoggerFields(appMd metadata.ApplicationMetadata) []zap.Field {
var baseLogFields []zap.Field
baseLogFields = appendFieldIfPresent(applicationName, appMd.Name, baseLogFields)
baseLogFields = appendFieldIfPresent(environment, appMd.Environment, baseLogFields)
baseLogFields = appendFieldIfPresent(replicaSet, appMd.Replicaset, baseLogFields)
baseLogFields = appendFieldIfPresent(hostname, appMd.Hostname, baseLogFields)
baseLogFields = appendFieldIfPresent(version, appMd.Version, baseLogFields)
return baseLogFields
}
func armoryStdLogOpt() []zap.Option {
return []zap.Option{
zap.WithCaller(true),
// our internal error handling will add stack traces intelligently.
zap.AddStacktrace(zap.DPanicLevel),
}
}
func StdArmoryDevLogger(level zapcore.Level) (*zap.Logger, error) {
return createArmoryConsoleLogger(armoryStdLogOpt(), level)
}
func createArmoryConsoleLogger(loggerOptions []zap.Option, level zapcore.Level) (*zap.Logger, error) {
sink, closeOut, err := zap.Open("stderr")
if err != nil {
return nil, err
}
errSink, _, err := zap.Open("stderr")
if err != nil {
closeOut()
return nil, err
}
loggerOptions = append(loggerOptions,
zap.ErrorOutput(errSink),
zap.Development(),
zap.AddCaller(),
)
disableColors := false
if os.Getenv("DISABLE_COLORS") == "true" {
disableColors = true
}
return zap.New(
zapcore.NewCore(NewArmoryDevConsoleEncoder(disableColors), sink, zap.NewAtomicLevelAt(level)),
loggerOptions...,
), nil
}
func appendFieldIfPresent(key string, value string, fields []zap.Field) []zap.Field {
if value != "" {
return append(fields, zap.String(key, value))
}
return fields
}
var Module = fx.Options(
fx.Provide(ArmoryLoggerProvider),
fx.Provide(func(log *zap.Logger) *zap.SugaredLogger {
return log.Sugar()
}),
fx.WithLogger(func(logger *zap.Logger) fxevent.Logger {
return &fxevent.ZapLogger{Logger: logger}
}),
)