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
|
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.
package common
import "log"
// Logger define the way to receive logs from Consensus instance.
// NOTE: parameter in 'ctx' should be paired as key-value mapping. For example,
// to log an error with message:
// logger.Error("some message", "error", err)
// which is similar to loggers with context:
// logger.Error("some message", map[string]interface{}{
// "error": err,
// })
type Logger interface {
// Info logs info level logs.
Trace(msg string, ctx ...interface{})
Debug(msg string, ctx ...interface{})
Info(msg string, ctx ...interface{})
Warn(msg string, ctx ...interface{})
Error(msg string, ctx ...interface{})
}
// NullLogger logs nothing.
type NullLogger struct{}
// Trace implements Logger interface.
func (logger *NullLogger) Trace(msg string, ctx ...interface{}) {
}
// Debug implements Logger interface.
func (logger *NullLogger) Debug(msg string, ctx ...interface{}) {
}
// Info implements Logger interface.
func (logger *NullLogger) Info(msg string, ctx ...interface{}) {
}
// Warn implements Logger interface.
func (logger *NullLogger) Warn(msg string, ctx ...interface{}) {
}
// Error implements Logger interface.
func (logger *NullLogger) Error(msg string, ctx ...interface{}) {
}
// SimpleLogger logs everything.
type SimpleLogger struct{}
// composeVargs makes (msg, ctx...) could be pass to log.Println
func composeVargs(msg string, ctxs []interface{}) []interface{} {
args := []interface{}{msg}
for _, c := range ctxs {
args = append(args, c)
}
return args
}
// Trace implements Logger interface.
func (logger *SimpleLogger) Trace(msg string, ctx ...interface{}) {
log.Println(composeVargs(msg, ctx)...)
}
// Debug implements Logger interface.
func (logger *SimpleLogger) Debug(msg string, ctx ...interface{}) {
log.Println(composeVargs(msg, ctx)...)
}
// Info implements Logger interface.
func (logger *SimpleLogger) Info(msg string, ctx ...interface{}) {
log.Println(composeVargs(msg, ctx)...)
}
// Warn implements Logger interface.
func (logger *SimpleLogger) Warn(msg string, ctx ...interface{}) {
log.Println(composeVargs(msg, ctx)...)
}
// Error implements Logger interface.
func (logger *SimpleLogger) Error(msg string, ctx ...interface{}) {
log.Println(composeVargs(msg, ctx)...)
}
// CustomLogger logs everything.
type CustomLogger struct {
logger *log.Logger
}
// NewCustomLogger creates a new custom logger.
func NewCustomLogger(logger *log.Logger) *CustomLogger {
return &CustomLogger{
logger: logger,
}
}
// Trace implements Logger interface.
func (logger *CustomLogger) Trace(msg string, ctx ...interface{}) {
logger.logger.Println(composeVargs(msg, ctx)...)
}
// Debug implements Logger interface.
func (logger *CustomLogger) Debug(msg string, ctx ...interface{}) {
logger.logger.Println(composeVargs(msg, ctx)...)
}
// Info implements Logger interface.
func (logger *CustomLogger) Info(msg string, ctx ...interface{}) {
logger.logger.Println(composeVargs(msg, ctx)...)
}
// Warn implements Logger interface.
func (logger *CustomLogger) Warn(msg string, ctx ...interface{}) {
logger.logger.Println(composeVargs(msg, ctx)...)
}
// Error implements Logger interface.
func (logger *CustomLogger) Error(msg string, ctx ...interface{}) {
logger.logger.Println(composeVargs(msg, ctx)...)
}
|
