-
Notifications
You must be signed in to change notification settings - Fork 4
/
adapter.go
401 lines (337 loc) · 10.3 KB
/
adapter.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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package bilog
import (
"fmt"
"os"
"reflect"
"runtime/debug"
"sort"
"strconv"
"time"
"github.com/insolar/assured-ledger/ledger-core/log"
"github.com/insolar/assured-ledger/ledger-core/log/adapters/bilog/msgencoder"
"github.com/insolar/assured-ledger/ledger-core/log/logcommon"
"github.com/insolar/assured-ledger/ledger-core/log/logfmt"
"github.com/insolar/assured-ledger/ledger-core/log/logoutput"
)
var (
CallerMarshalFunc = func(file string, line int) string {
return file + ":" + strconv.Itoa(line)
}
)
var _ logcommon.EmbeddedLogger = &binLogAdapter{}
var _ logcommon.EmbeddedLoggerOptional = &binLogAdapter{}
type binLogAdapter struct {
config *logcommon.Config
encoder msgencoder.Encoder
writer logcommon.LoggerOutput
parentStatic []byte
staticFields []byte
dynFields dynFieldList // sorted
expectedEventLen int
levelFilter log.Level
lowLatency bool
recycleBuf bool
}
const loggerSkipFrameCount = 3
func (v binLogAdapter) prepareEncoder(level log.Level, preallocate int) objectEncoder {
if preallocate < minEventBuffer {
preallocate = minEventBuffer
} else if preallocate > minEventBuffer {
preallocate += maxEventBufferIncrement
}
encoder := objectEncoder{v.encoder, nil, nil, time.Now(), false, level}
// level == logcommon.DebugLevel || level >= logcommon.WarnLevel
// This must be aligned with zlog
encoder.allowTrace = true
switch {
case v.recycleBuf:
encoder.poolBuf = allocateBuffer(preallocate)
if encoder.poolBuf != nil {
encoder.content = (*encoder.poolBuf)[:0]
break
}
fallthrough
default:
encoder.content = make([]byte, 0, preallocate)
}
encoder.content = v.encoder.PrepareBuffer(encoder.content, logoutput.LevelFieldName, level)
if v.config.Instruments.MetricsMode&logcommon.LogMetricsTimestamp != 0 {
encoder.AddTimeField(logoutput.TimestampFieldName, encoder.reportedAt, logfmt.LogFieldFormat{})
}
switch withFuncName := false; v.config.Instruments.CallerMode {
case logcommon.CallerFieldWithFuncName:
withFuncName = true
fallthrough
case logcommon.CallerField:
skipFrameCount := int(v.config.Instruments.SkipFrameCountBaseline) + int(v.config.Instruments.SkipFrameCount)
fileName, funcName, line := logoutput.GetCallerInfo(skipFrameCount + loggerSkipFrameCount)
fileName = CallerMarshalFunc(fileName, line)
encoder.AddStrField(logoutput.CallerFieldName, fileName, logfmt.LogFieldFormat{})
if withFuncName {
encoder.AddStrField(logoutput.FuncFieldName, funcName, logfmt.LogFieldFormat{})
}
}
encoder.content = encoder.fieldEncoder.AppendParts(encoder.content, [][]byte{ v.parentStatic, v.staticFields })
for _, field := range v.dynFields {
val := field.Getter()
if val == nil {
continue
}
encoder.AddIntfField(field.Name, val, logfmt.LogFieldFormat{})
}
return encoder
}
func (v binLogAdapter) sendEvent(encoder objectEncoder, msgStr string, completed *bool) {
encoder.AddStrField(logoutput.MessageFieldName, msgStr, logfmt.LogFieldFormat{})
var content []byte
if v.config.Instruments.MetricsMode.HasWriteMetric() {
content = v.encoder.FinalizeBuffer(encoder.content, encoder.reportedAt)
} else {
content = v.encoder.FinalizeBuffer(encoder.content, time.Time{})
}
// NB! writer's methods can call runtime.Goexit() etc
// So we have to mark our part as completed before it
*completed = true
level := encoder.level
var err error
if v.lowLatency {
_, err = v.writer.LowLatencyWrite(level, content)
} else {
_, err = v.writer.LogLevelWrite(level, content)
}
if level == log.FatalLevel {
// MUST NOT do it before writer's call to properly handle runtime.Goexit()
// make sure not to loose Fatal by an internal panic
defer os.Exit(1)
}
if encoder.poolBuf != nil {
reuseBuffer(encoder.poolBuf)
}
switch {
case err == nil:
//
case v.config.ErrorFn != nil:
v.config.ErrorFn(err)
default:
_, _ = fmt.Fprintf(os.Stderr, "bilog: could not write event: %v\n", err)
}
if level == log.PanicLevel {
panic(msgStr)
}
}
func (v binLogAdapter) doneEvent(level log.Level, recovered interface{}) {
switch {
case recovered == nil:
// this is runtime.Goexit() - probably is caused by testing.T.FatalNow() - don't use os.Exit()
return
case level == log.FatalLevel:
// make sure not to loose Fatal by an internal panic
defer os.Exit(1)
}
var err error
if e, ok := recovered.(error); ok {
err = e
} else {
err = fmt.Errorf("internal error (%v)", recovered)
}
switch {
case v.config.ErrorFn != nil:
v.config.ErrorFn(err)
default:
_, _ = fmt.Fprintf(os.Stderr, "bilog: could not handle event, %v\n\tstack:\n%s", err, debug.Stack())
}
}
func (v binLogAdapter) NewEventStruct(level log.Level) func(interface{}, []logfmt.LogFieldMarshaller) {
if !v.Is(level) {
return nil
}
return func(arg interface{}, fields []logfmt.LogFieldMarshaller) {
completed := false
defer func() {
if !completed {
v.doneEvent(level, recover())
}
}()
event := v.prepareEncoder(level, v.expectedEventLen)
for _, f := range fields {
f.MarshalLogFields(&event)
}
obj, msgStr := v.config.MsgFormat.FmtLogStruct(arg)
if obj != nil {
collector := v.config.Metrics.GetMetricsCollector()
msgStr, _ = obj.MarshalLogObject(&event, collector)
}
v.sendEvent(event, msgStr, &completed)
}
}
func (v binLogAdapter) NewEvent(level log.Level) func(args []interface{}) {
if !v.Is(level) {
return nil
}
return func(args []interface{}) {
completed := false
defer func() {
if !completed {
v.doneEvent(level, recover())
}
}()
if len(args) != 1 {
msgStr := v.config.MsgFormat.FmtLogObject(args...)
event := v.prepareEncoder(level, v.expectedEventLen)
v.sendEvent(event, msgStr, &completed)
return
}
obj, msgStr := v.config.MsgFormat.FmtLogStructOrObject(args[0])
event := v.prepareEncoder(level, v.expectedEventLen)
if obj != nil {
collector := v.config.Metrics.GetMetricsCollector()
msgStr, _ = obj.MarshalLogObject(&event, collector)
}
v.sendEvent(event, msgStr, &completed)
}
}
func (v binLogAdapter) NewEventFmt(level log.Level) func(fmt string, args []interface{}) {
if !v.Is(level) {
return nil
}
return func(fmt string, args []interface{}) {
completed := false
defer func() {
if !completed {
v.doneEvent(level, recover())
}
}()
msgStr := v.config.MsgFormat.Sformatf(fmt, args...)
event := v.prepareEncoder(level, len(msgStr))
v.sendEvent(event, msgStr, &completed)
}
}
func (v binLogAdapter) EmbeddedFlush(msgStr string) {
if len(msgStr) == 0 {
_ = v.config.LoggerOutput.Flush()
return
}
const level = log.WarnLevel
completed := false
defer func() {
if !completed {
v.doneEvent(level, recover())
}
_ = v.config.LoggerOutput.Flush()
}()
event := v.prepareEncoder(level, len(msgStr))
v.sendEvent(event, msgStr, &completed)
}
func (v binLogAdapter) Is(level log.Level) bool {
return level >= v.levelFilter && level >= getGlobalFilter()
}
// NB! Reference receiver allows the builder to return the existing instance when nothing was changed, otherwise it will make a copy
func (v *binLogAdapter) Copy() logcommon.EmbeddedLoggerBuilder {
return binLogTemplate{template: v, binLogFactory: binLogFactory{recycleBuf: v.recycleBuf}}
}
func (v binLogAdapter) GetLoggerOutput() logcommon.LoggerOutput {
return v.config.LoggerOutput
}
func (v binLogAdapter) FieldsOf(data reflect.Value) logfmt.LogObjectMarshaller {
return v.config.MsgFormat.MFactory.CreateLogObjectMarshaller(data)
}
func (v binLogAdapter) _prepareAppendFields(nExpected int) objectEncoder {
var buf []byte
switch required, available := estimateBufferSizeByFields(nExpected), cap(v.staticFields)-len(v.staticFields); {
case required <= available:
buf = make([]byte, 0, cap(v.staticFields))
default:
buf = make([]byte, 0, len(v.staticFields)+required)
}
buf = append(buf, v.staticFields...)
return objectEncoder{v.encoder, nil, buf, time.Time{}, false, 0}
}
// NB! Reference receiver allows return of the existing instance when nothing was changed, otherwise it will make a copy
func (v *binLogAdapter) WithFields(fields map[string]interface{}) logcommon.EmbeddedLogger {
switch len(fields) {
case 0:
return v
case 1:
// avoids sorting inside addIntfFields()
for k, val := range fields {
return v.WithField(k, val)
}
}
return v.withFields(fields)
}
func (v binLogAdapter) withFields(fields map[string]interface{}) logcommon.EmbeddedLogger {
objEncoder := v._prepareAppendFields(len(fields))
objEncoder.addIntfFields(fields)
v.staticFields = objEncoder.content
return &v
}
func (v binLogAdapter) WithField(name string, value interface{}) logcommon.EmbeddedLogger {
objEncoder := v._prepareAppendFields(1)
objEncoder.AddIntfField(name, value, logfmt.LogFieldFormat{})
v.staticFields = objEncoder.content
return &v
}
// Can ONLY be used by the builder
func (v *binLogAdapter) _addFieldsByBuilder(fields map[string]interface{}) {
if len(fields) == 0 {
return
}
var newFields *[]byte
if n := len(v.staticFields); n > 0 {
buf := make([]byte, 0, n+len(v.parentStatic)+estimateBufferSizeByFields(len(fields)))
buf = append(buf, v.parentStatic...)
buf = append(buf, v.staticFields...)
v.parentStatic = buf
v.staticFields = nil
newFields = &v.parentStatic
} else {
v.staticFields = make([]byte, 0, maxEventBufferIncrement)
newFields = &v.staticFields
}
objEncoder := objectEncoder{v.encoder, nil, *newFields, time.Time{}, false, 0}
objEncoder.addIntfFields(fields)
*newFields = objEncoder.content
}
// Can ONLY be used by the builder
func (v *binLogAdapter) _addDynFieldsByBuilder(newFields logcommon.DynFieldMap) {
switch {
case len(newFields) == 0:
return
case len(v.dynFields) > 0:
fields := make(logcommon.DynFieldMap, len(newFields)+len(v.dynFields))
for _, ve := range v.dynFields {
fields[ve.Name] = ve.Getter
}
for k, v := range newFields {
if v == nil {
delete(fields, k)
} else {
fields[k] = v
}
}
newFields = fields
}
v.dynFields = make(dynFieldList, 0, len(newFields))
for k, val := range newFields {
v.dynFields = append(v.dynFields, dynFieldEntry{k, val})
}
v.dynFields.Sort()
}
/* =========================== */
type dynFieldEntry struct {
Name string
Getter logcommon.DynFieldFunc
}
type dynFieldList []dynFieldEntry
func (v dynFieldList) Sort() {
sort.Sort(v)
}
func (v dynFieldList) Len() int {
return len(v)
}
func (v dynFieldList) Less(i, j int) bool {
return v[i].Name < v[j].Name
}
func (v dynFieldList) Swap(i, j int) {
v[i], v[j] = v[j], v[i]
}