aboutsummaryrefslogtreecommitdiffstats
path: root/log/logger.go
blob: 438aa548fa44ac45af08a2eb9d01513d91c7c349 (plain) (blame)
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
package log

import (
    "fmt"
    "os"
    "time"

    "github.com/go-stack/stack"
)

const timeKey = "t"
const lvlKey = "lvl"
const msgKey = "msg"
const errorKey = "LOG15_ERROR"
const skipLevel = 2

type Lvl int

const (
    LvlCrit Lvl = iota
    LvlError
    LvlWarn
    LvlInfo
    LvlDebug
    LvlTrace
)

// AlignedString returns a 5-character string containing the name of a Lvl.
func (l Lvl) AlignedString() string {
    switch l {
    case LvlTrace:
        return "TRACE"
    case LvlDebug:
        return "DEBUG"
    case LvlInfo:
        return "INFO "
    case LvlWarn:
        return "WARN "
    case LvlError:
        return "ERROR"
    case LvlCrit:
        return "CRIT "
    default:
        panic("bad level")
    }
}

// Strings returns the name of a Lvl.
func (l Lvl) String() string {
    switch l {
    case LvlTrace:
        return "trce"
    case LvlDebug:
        return "dbug"
    case LvlInfo:
        return "info"
    case LvlWarn:
        return "warn"
    case LvlError:
        return "eror"
    case LvlCrit:
        return "crit"
    default:
        panic("bad level")
    }
}

// LvlFromString returns the appropriate Lvl from a string name.
// Useful for parsing command line args and configuration files.
func LvlFromString(lvlString string) (Lvl, error) {
    switch lvlString {
    case "trace", "trce":
        return LvlTrace, nil
    case "debug", "dbug":
        return LvlDebug, nil
    case "info":
        return LvlInfo, nil
    case "warn":
        return LvlWarn, nil
    case "error", "eror":
        return LvlError, nil
    case "crit":
        return LvlCrit, nil
    default:
        return LvlDebug, fmt.Errorf("Unknown level: %v", lvlString)
    }
}

// A Record is what a Logger asks its handler to write
type Record struct {
    Time     time.Time
    Lvl      Lvl
    Msg      string
    Ctx      []interface{}
    Call     stack.Call
    KeyNames RecordKeyNames
}

// RecordKeyNames gets stored in a Record when the write function is executed.
type RecordKeyNames struct {
    Time string
    Msg  string
    Lvl  string
}

// A Logger writes key/value pairs to a Handler
type Logger interface {
    // New returns a new Logger that has this logger's context plus the given context
    New(ctx ...interface{}) Logger

    // GetHandler gets the handler associated with the logger.
    GetHandler() Handler

    // SetHandler updates the logger to write records to the specified handler.
    SetHandler(h Handler)

    // Log a message at the given level with context key/value pairs
    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{})
    Crit(msg string, ctx ...interface{})
}

type logger struct {
    ctx []interface{}
    h   *swapHandler
}

func (l *logger) write(msg string, lvl Lvl, ctx []interface{}, skip int) {
    l.h.Log(&Record{
        Time: time.Now(),
        Lvl:  lvl,
        Msg:  msg,
        Ctx:  newContext(l.ctx, ctx),
        Call: stack.Caller(skip),
        KeyNames: RecordKeyNames{
            Time: timeKey,
            Msg:  msgKey,
            Lvl:  lvlKey,
        },
    })
}

func (l *logger) New(ctx ...interface{}) Logger {
    child := &logger{newContext(l.ctx, ctx), new(swapHandler)}
    child.SetHandler(l.h)
    return child
}

func newContext(prefix []interface{}, suffix []interface{}) []interface{} {
    normalizedSuffix := normalize(suffix)
    newCtx := make([]interface{}, len(prefix)+len(normalizedSuffix))
    n := copy(newCtx, prefix)
    copy(newCtx[n:], normalizedSuffix)
    return newCtx
}

func (l *logger) Trace(msg string, ctx ...interface{}) {
    l.write(msg, LvlTrace, ctx, skipLevel)
}

func (l *logger) Debug(msg string, ctx ...interface{}) {
    l.write(msg, LvlDebug, ctx, skipLevel)
}

func (l *logger) Info(msg string, ctx ...interface{}) {
    l.write(msg, LvlInfo, ctx, skipLevel)
}

func (l *logger) Warn(msg string, ctx ...interface{}) {
    l.write(msg, LvlWarn, ctx, skipLevel)
}

func (l *logger) Error(msg string, ctx ...interface{}) {
    l.write(msg, LvlError, ctx, skipLevel)
}

func (l *logger) Crit(msg string, ctx ...interface{}) {
    l.write(msg, LvlCrit, ctx, skipLevel)
    os.Exit(1)
}

func (l *logger) GetHandler() Handler {
    return l.h.Get()
}

func (l *logger) SetHandler(h Handler) {
    l.h.Swap(h)
}

func normalize(ctx []interface{}) []interface{} {
    // if the caller passed a Ctx object, then expand it
    if len(ctx) == 1 {
        if ctxMap, ok := ctx[0].(Ctx); ok {
            ctx = ctxMap.toArray()
        }
    }

    // ctx needs to be even because it's a series of key/value pairs
    // no one wants to check for errors on logging functions,
    // so instead of erroring on bad input, we'll just make sure
    // that things are the right length and users can fix bugs
    // when they see the output looks wrong
    if len(ctx)%2 != 0 {
        ctx = append(ctx, nil, errorKey, "Normalized odd number of arguments by adding nil")
    }

    return ctx
}

// Lazy allows you to defer calculation of a logged value that is expensive
// to compute until it is certain that it must be evaluated with the given filters.
//
// Lazy may also be used in conjunction with a Logger's New() function
// to generate a child logger which always reports the current value of changing
// state.
//
// You may wrap any function which takes no arguments to Lazy. It may return any
// number of values of any type.
type Lazy struct {
    Fn interface{}
}

// Ctx is a map of key/value pairs to pass as context to a log function
// Use this only if you really need greater safety around the arguments you pass
// to the logging functions.
type Ctx map[string]interface{}

func (c Ctx) toArray() []interface{} {
    arr := make([]interface{}, len(c)*2)

    i := 0
    for k, v := range c {
        arr[i] = k
        arr[i+1] = v
        i += 2
    }

    return arr
}