aboutsummaryrefslogtreecommitdiff
path: root/logger.go
blob: 9ac23c8c9504c4e82697176871abcf26a1083dce (plain)
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
package logger

import (
	"fmt"
	"os"
	"strings"
	"sync"
	"time"

	"src.userspace.com.au/logger/message"
	"src.userspace.com.au/logger/writers/kv"
)

// Logger is a simple logger with optional structured.
type Logger struct {
	debug   bool
	name    string
	fields  map[string]string
	writers []message.Writer
	lock    *sync.RWMutex
}

// New creates a new logger instance
func New(opts ...Option) (*Logger, error) {
	l := &Logger{
		debug:   (os.Getenv("DEBUG") != ""),
		fields:  make(map[string]string),
		lock:    new(sync.RWMutex),
		writers: []message.Writer{},
	}

	// Apply variadic options
	for _, opt := range opts {
		if err := opt(l); err != nil {
			return nil, err
		}
	}

	// Add default writer
	if len(l.writers) == 0 {
		kv, err := kv.New(kv.SetOutput(os.Stderr))
		if err != nil {
			return nil, err
		}
		l.writers = []message.Writer{kv}
	}
	return l, nil
}

// Log a message.
func (l *Logger) Log(args ...interface{}) *Logger {
	return l.log(args...)
}

func (l *Logger) log(args ...interface{}) *Logger {
	if len(args) == 0 {
		return l
	}
	m := message.Message{
		Name:    l.name,
		Time:    time.Now(),
		Content: toString(args...),
		Fields:  l.fields,
	}

	for _, w := range l.writers {
		w.Write(m)
	}
	return l
}

// toString converts interface to string
func toString(args ...interface{}) string {
	var buf strings.Builder
	last := len(args)
	for i, a := range args {
		buf.WriteString(fmt.Sprint(a))
		if i < last-1 {
			buf.WriteByte(' ')
		}
	}
	return buf.String()
}

// Info is an alias for Log.
func (l *Logger) Info(args ...interface{}) *Logger {
	return l.log(args...)
}

// Debug logs a debug message.
func (l *Logger) Debug(args ...interface{}) *Logger {
	if l.debug {
		return l.log(args...)
	}
	return l
}

// IsDebug determines the debug status for a logger instance.
// Use this to conditionally execute blocks of code depending on the log verbosity.
func (l *Logger) IsDebug() bool { return l.debug }

// Field enables setting or changing the default fields for a logger instance.
func (l *Logger) Field(k string, v interface{}) *Logger {
	l.lock.Lock()
	defer l.lock.Unlock()

	l.fields[k] = toString(v)
	return l
}

// Fields enables setting or changing the default fields for a logger instance.
func (l *Logger) Fields(args ...interface{}) *Logger {
	l.lock.Lock()
	defer l.lock.Unlock()

	if len(args)%2 != 0 {
		args = append(args, "")
	}
	for i := 0; i < len(args); i += 2 {
		l.fields[toString(args[i])] = toString(args[i+1])
	}
	return l
}

// FieldMap enables setting or changing the default fields for a logger instance.
func (l *Logger) FieldMap(f map[string]interface{}) *Logger {
	l.lock.Lock()
	defer l.lock.Unlock()

	for k, v := range f {
		l.fields[k] = toString(v)
	}
	return l
}

// Named creates a new instance of a logger with a new name.
func (l *Logger) Named(n string) *Logger {
	nl := *l
	if l.name != "" {
		nl.name = l.name + "." + n
	} else {
		nl.name = n
	}
	return &nl
}