-
Notifications
You must be signed in to change notification settings - Fork 4
/
builder.go
313 lines (248 loc) · 8.03 KB
/
builder.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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
package zlog
import (
"errors"
"io"
"github.com/rs/zerolog"
"github.com/insolar/assured-ledger/ledger-core/log/logcommon"
)
func selectFormatter(format logcommon.LogFormat, output io.Writer) (io.Writer, error) {
switch format {
case logcommon.TextFormat:
return newDefaultTextOutput(output), nil
case logcommon.JSONFormat:
return output, nil
default:
return nil, errors.New("unknown formatter " + format.String())
}
}
const ZerologSkipFrameCount = 4
func NewFactory() logcommon.Factory {
return zerologFactory{}
}
/* ============================ */
var _ logcommon.Factory = zerologFactory{}
type zerologFactory struct {
writeDelayPreferTrim bool
}
func (zf zerologFactory) GetGlobalLogAdapter() logcommon.GlobalLogAdapter {
return zerologGlobalAdapter
}
func (zf zerologFactory) PrepareBareOutput(output logcommon.BareOutput, metrics *logcommon.MetricsHelper, config logcommon.BuildConfig) (io.Writer, error) {
outputWriter, err := selectFormatter(config.Output.Format, output.Writer)
if err != nil {
return nil, err
}
if ok, name, reportFn := getWriteDelayConfig(metrics, config); ok {
outputWriter = newWriteDelayPostHook(outputWriter, name, zf.writeDelayPreferTrim, reportFn)
}
return outputWriter, nil
}
func checkNewLoggerOutput(output zerolog.LevelWriter) zerolog.LevelWriter {
if output == nil {
panic("illegal value")
}
//
return output
}
func (zf zerologFactory) createNewLogger(output zerolog.LevelWriter, params logcommon.NewLoggerParams, template *zerologAdapter,
) (logcommon.EmbeddedLogger, error) {
instruments := params.Config.Instruments
skipFrames := int(instruments.SkipFrameCountBaseline) + int(instruments.SkipFrameCount)
callerMode := instruments.CallerMode
cfg := params.Config
la := zerologAdapter{
// NB! We have to create a new logger and pass the context separately
// Otherwise, zerolog will also copy hooks - which we need to get rid of some.
logger: zerolog.New(checkNewLoggerOutput(output)).Level(ToZerologLevel(params.Level)),
config: &cfg,
}
if ok, name, _ := getWriteDelayConfig(params.Config.Metrics, params.Config.BuildConfig); ok {
la.logger = la.logger.Hook(newWriteDelayPreHook(name, zf.writeDelayPreferTrim))
}
{ // replacement and inheritance for dynFields
switch newFields := params.DynFields; {
case template != nil && params.Reqs&logcommon.RequiresParentDynFields != 0 && len(template.dynFields) > 0:
prevFields := template.dynFields
if len(newFields) > 0 {
for k, v := range prevFields {
if _, ok := newFields[k]; !ok {
newFields[k] = v
}
}
} else {
newFields = prevFields
}
fallthrough
case len(newFields) > 0:
la.dynFields = newFields
la.logger = la.logger.Hook(newDynFieldsHook(newFields))
}
}
if callerMode == logcommon.CallerFieldWithFuncName {
la.logger = la.logger.Hook(newCallerHook(skipFrames))
}
lc := la.logger.With()
// NB! only add hooks below this line, DON'T set the context as it can be replaced below
if params.Config.Instruments.MetricsMode&logcommon.LogMetricsTimestamp != 0 {
lc = lc.Timestamp()
}
if callerMode == logcommon.CallerField {
lc = lc.CallerWithSkipFrameCount(skipFrames)
}
replaceContext := false
if template != nil && params.Reqs&logcommon.RequiresParentCtxFields != 0 {
la.logger = lc.Logger() // save hooks
lc = template.logger.With() // get a copy of the inherited context
replaceContext = true
}
for k, v := range params.Fields {
lc = lc.Interface(k, v)
}
if replaceContext {
// use fields, but not hooks
la.logger.UpdateContext(func(zerolog.Context) zerolog.Context {
return lc
})
} else {
la.logger = lc.Logger()
}
return &la, nil
}
func (zf zerologFactory) copyLogger(template *zerologAdapter, params logcommon.CopyLoggerParams) logcommon.EmbeddedLogger {
if params.Reqs&logcommon.RequiresParentDynFields == 0 {
// have to reset hooks, but zerolog can't reset hooks
// so we have to create the logger from scratch
return nil
}
hasUpdates := false
la := *template
if newFields := params.AppendDynFields; len(newFields) > 0 {
if prevFields := la.dynFields; len(prevFields) > 0 {
// NB! avoid modification of newFields when nil can be returned
for k := range newFields {
if _, ok := prevFields[k]; ok {
// key collision
// have to reset hooks, but zerolog can't reset hooks
// so we have to create the logger from scratch
return nil
}
}
for k, v := range prevFields {
newFields[k] = v
}
}
la.dynFields = newFields
la.logger = la.logger.Hook(newDynFieldsHook(newFields))
hasUpdates = true
}
newLevel := ToZerologLevel(params.Level)
if template.logger.GetLevel() != newLevel {
la.logger = la.logger.Level(newLevel)
hasUpdates = true
}
{
hasCtxUpdates := false
var lc zerolog.Context
if params.Reqs&logcommon.RequiresParentCtxFields == 0 {
// have to reset logger context
lc = zerolog.New(nil).With()
hasCtxUpdates = true
}
if len(params.AppendFields) > 0 {
if !hasCtxUpdates {
lc = la.logger.With()
}
for k, v := range params.AppendFields {
lc = lc.Interface(k, v)
}
hasCtxUpdates = true
}
if hasCtxUpdates {
la.logger.UpdateContext(func(zerolog.Context) zerolog.Context {
return lc
})
hasUpdates = true
}
}
if !hasUpdates {
return template
}
return &la
}
func (zf zerologFactory) createOutputWrapper(config logcommon.Config, reqs logcommon.FactoryRequirementFlags) zerolog.LevelWriter {
if reqs&logcommon.RequiresLowLatency != 0 {
return zerologAdapterLLOutput{config.LoggerOutput}
}
return zerologAdapterOutput{config.LoggerOutput}
}
func (zf zerologFactory) CreateNewLogger(params logcommon.NewLoggerParams) (logcommon.EmbeddedLogger, error) {
output := zf.createOutputWrapper(params.Config, params.Reqs)
return zf.createNewLogger(output, params, nil)
}
func (zf zerologFactory) CanReuseMsgBuffer() bool {
// zerolog does recycling of []byte buffers
return false
}
/* ============================ */
var _ logcommon.Template = &zerologTemplate{}
type zerologTemplate struct {
zerologFactory
template *zerologAdapter
}
func (zf zerologTemplate) GetTemplateLevel() logcommon.Level {
return FromZerologLevel(zf.template.logger.GetLevel())
}
func (zf zerologTemplate) GetLoggerOutput() logcommon.LoggerOutput {
return zf.template.GetLoggerOutput()
}
func (zf zerologTemplate) GetTemplateConfig() logcommon.Config {
return *zf.template.config
}
func (zf zerologTemplate) CopyTemplateLogger(params logcommon.CopyLoggerParams) logcommon.EmbeddedLogger {
return zf.copyLogger(zf.template, params)
}
func (zf zerologTemplate) CreateNewLogger(params logcommon.NewLoggerParams) (logcommon.EmbeddedLogger, error) {
output := zf.createOutputWrapper(params.Config, params.Reqs)
return zf.createNewLogger(output, params, zf.template)
}
/* ========================================= */
var _ zerolog.LevelWriter = &zerologAdapterOutput{}
type zerologAdapterOutput struct {
logcommon.LoggerOutput
}
func (z zerologAdapterOutput) WriteLevel(level zerolog.Level, b []byte) (int, error) {
return z.LoggerOutput.LogLevelWrite(FromZerologLevel(level), b)
}
func (z zerologAdapterOutput) Write(b []byte) (int, error) {
panic("unexpected") // zerolog writes only to WriteLevel
}
/* ========================================= */
var _ zerolog.LevelWriter = &zerologAdapterLLOutput{}
type zerologAdapterLLOutput struct {
logcommon.LoggerOutput
}
func (z zerologAdapterLLOutput) WriteLevel(level zerolog.Level, b []byte) (int, error) {
return z.LoggerOutput.LowLatencyWrite(FromZerologLevel(level), b)
}
func (z zerologAdapterLLOutput) Write(b []byte) (int, error) {
panic("unexpected") // zerolog writes only to WriteLevel
}
/* ========================================= */
func newDynFieldsHook(dynFields logcommon.DynFieldMap) zerolog.Hook {
return dynamicFieldsHook{dynFields}
}
type dynamicFieldsHook struct {
dynFields logcommon.DynFieldMap
}
func (v dynamicFieldsHook) Run(e *zerolog.Event, level zerolog.Level, message string) {
for k, fn := range v.dynFields {
if fn == nil {
continue
}
vv := fn()
if vv == nil {
continue
}
e.Interface(k, vv)
}
}