-
Notifications
You must be signed in to change notification settings - Fork 85
/
logger.go
241 lines (203 loc) · 5.71 KB
/
logger.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
package logging
import (
"context"
"fmt"
"io"
"log/slog"
"sync"
"time"
"github.com/grafana/alloy/internal/component/common/loki"
"github.com/grafana/alloy/internal/slogadapter"
"github.com/grafana/loki/pkg/logproto"
"github.com/prometheus/common/model"
)
type EnabledAware interface {
Enabled(context.Context, slog.Level) bool
}
// Logger is the logging subsystem of Alloy. It supports being dynamically
// updated at runtime.
type Logger struct {
inner io.Writer // Writer passed to New.
bufferMut sync.RWMutex
buffer []*bufferedItem // Store logs before correctly determine the log format
hasLogFormat bool // Confirmation whether log format has been determined
level *slog.LevelVar // Current configured level.
format *formatVar // Current configured format.
writer *writerVar // Current configured multiwriter (inner + write_to).
handler *handler // Handler which handles logs.
deferredSlog *deferredSlogHandler // This handles deferred logging for slog.
}
var _ EnabledAware = (*Logger)(nil)
// Enabled implements EnabledAware interface.
func (l *Logger) Enabled(ctx context.Context, level slog.Level) bool {
return l.handler.Enabled(ctx, level)
}
// New creates a New logger with the default log level and format.
func New(w io.Writer, o Options) (*Logger, error) {
l, err := NewDeferred(w)
if err != nil {
return nil, err
}
if err = l.Update(o); err != nil {
return nil, err
}
return l, nil
}
// NewDeferred creates a new logger with the default log level and format.
// The logger is not updated during initialization.
func NewDeferred(w io.Writer) (*Logger, error) {
var (
leveler slog.LevelVar
format formatVar
writer writerVar
)
l := &Logger{
inner: w,
buffer: []*bufferedItem{},
hasLogFormat: false,
level: &leveler,
format: &format,
writer: &writer,
handler: &handler{
w: &writer,
leveler: &leveler,
formatter: &format,
replacer: replace,
},
}
l.deferredSlog = newDeferredHandler(l)
return l, nil
}
// Handler returns a [slog.Handler]. The returned Handler remains valid if l is
// updated.
func (l *Logger) Handler() slog.Handler { return l.deferredSlog }
// Update re-configures the options used for the logger.
func (l *Logger) Update(o Options) error {
l.bufferMut.Lock()
defer l.bufferMut.Unlock()
switch o.Format {
case FormatLogfmt, FormatJSON:
l.hasLogFormat = true
default:
return fmt.Errorf("unrecognized log format %q", o.Format)
}
l.level.Set(slogLevel(o.Level).Level())
l.format.Set(o.Format)
newWriter := l.inner
if len(o.WriteTo) > 0 {
newWriter = io.MultiWriter(l.inner, &lokiWriter{o.WriteTo})
}
l.writer.Set(newWriter)
// Build all our deferred handlers
if l.deferredSlog != nil {
l.deferredSlog.buildHandlers(nil)
}
// Print out the buffered logs since we determined the log format already
for _, bufferedLogChunk := range l.buffer {
if len(bufferedLogChunk.kvps) > 0 {
// the buffered logs are currently only sent to the standard output
// because the components with the receivers are not running yet
slogadapter.GoKit(l.handler).Log(bufferedLogChunk.kvps...)
} else {
// We now can check to see if if our buffered log is at the right level.
if bufferedLogChunk.handler.Enabled(context.Background(), bufferedLogChunk.record.Level) {
// These will always be valid due to the build handlers call above.
bufferedLogChunk.handler.Handle(context.Background(), bufferedLogChunk.record)
}
}
}
l.buffer = nil
return nil
}
// Log implements log.Logger.
func (l *Logger) Log(kvps ...interface{}) error {
// Buffer logs before confirming log format is configured in `logging` block
l.bufferMut.RLock()
if !l.hasLogFormat {
l.bufferMut.RUnlock()
l.bufferMut.Lock()
// Check hasLogFormat again; could have changed since the unlock.
if !l.hasLogFormat {
l.buffer = append(l.buffer, &bufferedItem{kvps: kvps})
l.bufferMut.Unlock()
return nil
}
l.bufferMut.Unlock()
} else {
l.bufferMut.RUnlock()
}
// NOTE(rfratto): this method is a temporary shim while log/slog is still
// being adopted throughout the codebase.
return slogadapter.GoKit(l.handler).Log(kvps...)
}
func (l *Logger) addRecord(r slog.Record, df *deferredSlogHandler) {
l.bufferMut.Lock()
defer l.bufferMut.Unlock()
l.buffer = append(l.buffer, &bufferedItem{
record: r,
handler: df,
})
}
type lokiWriter struct {
f []loki.LogsReceiver
}
func (fw *lokiWriter) Write(p []byte) (int, error) {
for _, receiver := range fw.f {
// We may have been given a nil value in rare circumstances due to
// misconfiguration or a component which generates exports after
// construction.
//
// Ignore nil values so we don't panic.
if receiver == nil {
continue
}
select {
case receiver.Chan() <- loki.Entry{
Labels: model.LabelSet{"component": "alloy"},
Entry: logproto.Entry{
Timestamp: time.Now(),
Line: string(p),
},
}:
default:
return 0, fmt.Errorf("lokiWriter failed to forward entry, channel was blocked")
}
}
return len(p), nil
}
type formatVar struct {
mut sync.RWMutex
f Format
}
func (f *formatVar) Format() Format {
f.mut.RLock()
defer f.mut.RUnlock()
return f.f
}
func (f *formatVar) Set(format Format) {
f.mut.Lock()
defer f.mut.Unlock()
f.f = format
}
type writerVar struct {
mut sync.RWMutex
w io.Writer
}
func (w *writerVar) Set(inner io.Writer) {
w.mut.Lock()
defer w.mut.Unlock()
w.w = inner
}
func (w *writerVar) Write(p []byte) (n int, err error) {
w.mut.RLock()
defer w.mut.RUnlock()
if w.w == nil {
return 0, fmt.Errorf("no writer available")
}
return w.w.Write(p)
}
type bufferedItem struct {
kvps []interface{}
handler *deferredSlogHandler
record slog.Record
}