-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathjson_logger.go
More file actions
330 lines (270 loc) · 8.42 KB
/
json_logger.go
File metadata and controls
330 lines (270 loc) · 8.42 KB
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
// SPDX-FileCopyrightText: 2026 The Pion community <https://pion.ly>
// SPDX-License-Identifier: MIT
package logging
import (
"context"
"fmt"
"io"
"log/slog"
"os"
"strings"
)
// jsonLeveledLogger provides JSON structured logging using Go's slog library.
type jsonLeveledLogger struct {
level LogLevel
writer *loggerWriter
logger *slog.Logger
scope string
}
var _ LeveledLogger = (*jsonLeveledLogger)(nil)
func (jl *jsonLeveledLogger) Slog() *slog.Logger {
return jl.logger
}
// newJSONLeveledLoggerForScope returns a configured JSON LeveledLogger.
func newJSONLeveledLoggerForScope(scope string, level LogLevel, writer io.Writer) *jsonLeveledLogger {
if writer == nil {
writer = os.Stderr
}
// Create a JSON handler with custom options
lw := &loggerWriter{output: writer}
logger := slog.New(newJSONHandlerHelper(lw))
return &jsonLeveledLogger{
level: level,
writer: lw,
logger: logger,
scope: scope,
}
}
// WithOutput is a chainable configuration function which sets the logger's
// logging output to the supplied io.Writer.
func (jl *jsonLeveledLogger) WithOutput(output io.Writer) LeveledLogger {
if output == nil {
output = os.Stderr
}
jl.writer.SetOutput(output)
return jl
}
// newJSONHandlerHelper creates a new JSON slog.Handler with custom formatting.
func newJSONHandlerHelper(w io.Writer) slog.Handler {
return slog.NewJSONHandler(w, &slog.HandlerOptions{
Level: slog.Level(-8), // Allow all levels, filter ourselves
ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
// Customize timestamp format
switch attr.Key {
case slog.LevelKey:
if lvl, ok := attr.Value.Any().(slog.Level); ok {
attr.Value = slogLevelToSlogStringValue(lvl)
return attr
}
// if slog changes representation then leave it alone.
return attr
default:
return attr
}
},
})
}
// SetLevel sets the logger's logging level.
func (jl *jsonLeveledLogger) SetLevel(newLevel LogLevel) {
jl.level.Set(newLevel)
}
// logf is the internal logging function that handles level checking and formatting.
func (jl *jsonLeveledLogger) logf(level slog.Level, msg string, args ...any) {
if jl.level.Get() < logLevelToPionLevel(level) {
return
}
// Create structured log entry
attrs := []any{
"scope", jl.scope,
}
// Add any additional arguments as key-value pairs
if len(args) > 0 {
attrs = append(attrs, args...)
}
jl.logger.Log(context.Background(), level, msg, attrs...)
}
// logfWithFormatf formats the message and calls logf.
func (jl *jsonLeveledLogger) logfWithFormatf(level slog.Level, format string, args ...any) {
if jl.level.Get() < logLevelToPionLevel(level) {
return
}
// Format the message
msg := format
if len(args) > 0 {
msg = fmt.Sprintf(format, args...)
}
// Create structured log entry
attrs := []any{
"scope", jl.scope,
}
jl.logger.Log(context.Background(), level, msg, attrs...)
}
// Convert slog record levels to the exact strings you want in JSON.
func slogLevelToSlogStringValue(level slog.Level) slog.Value {
switch level {
case slog.Level(-8): // trace
return slog.StringValue("TRACE")
case slog.LevelDebug:
return slog.StringValue("DEBUG")
case slog.LevelInfo:
return slog.StringValue("INFO")
case slog.LevelWarn:
return slog.StringValue("WARN")
case slog.LevelError:
return slog.StringValue("ERROR")
default:
return slog.StringValue("UNKNOWN")
}
}
// Helper to convert slog levels to Pion log levels.
func logLevelToPionLevel(level slog.Level) LogLevel {
switch level {
case slog.Level(-8): // trace
return LogLevelTrace
case slog.LevelDebug:
return LogLevelDebug
case slog.LevelInfo:
return LogLevelInfo
case slog.LevelWarn:
return LogLevelWarn
case slog.LevelError:
return LogLevelError
default:
return LogLevelDisabled
}
}
// Trace emits the preformatted message if the logger is at or below LogLevelTrace.
func (jl *jsonLeveledLogger) Trace(msg string) {
jl.logf(slog.Level(-8), msg) // slog.LevelTrace is -8
}
// Tracef formats and emits a message if the logger is at or below LogLevelTrace.
func (jl *jsonLeveledLogger) Tracef(format string, args ...any) {
jl.logfWithFormatf(slog.Level(-8), format, args...) // slog.LevelTrace is -8
}
// Debug emits the preformatted message if the logger is at or below LogLevelDebug.
func (jl *jsonLeveledLogger) Debug(msg string) {
jl.logf(slog.LevelDebug, msg)
}
// Debugf formats and emits a message if the logger is at or below LogLevelDebug.
func (jl *jsonLeveledLogger) Debugf(format string, args ...any) {
jl.logfWithFormatf(slog.LevelDebug, format, args...)
}
// Info emits the preformatted message if the logger is at or below LogLevelInfo.
func (jl *jsonLeveledLogger) Info(msg string) {
jl.logf(slog.LevelInfo, msg)
}
// Infof formats and emits a message if the logger is at or below LogLevelInfo.
func (jl *jsonLeveledLogger) Infof(format string, args ...any) {
jl.logfWithFormatf(slog.LevelInfo, format, args...)
}
// Warn emits the preformatted message if the logger is at or below LogLevelWarn.
func (jl *jsonLeveledLogger) Warn(msg string) {
jl.logf(slog.LevelWarn, msg)
}
// Warnf formats and emits a message if the logger is at or below LogLevelWarn.
func (jl *jsonLeveledLogger) Warnf(format string, args ...any) {
jl.logfWithFormatf(slog.LevelWarn, format, args...)
}
// Error emits the preformatted message if the logger is at or below LogLevelError.
func (jl *jsonLeveledLogger) Error(msg string) {
jl.logf(slog.LevelError, msg)
}
// Errorf formats and emits a message if the logger is at or below LogLevelError.
func (jl *jsonLeveledLogger) Errorf(format string, args ...any) {
jl.logfWithFormatf(slog.LevelError, format, args...)
}
// jsonLoggerFactory defines levels by scopes and creates new jsonLeveledLogger.
type jsonLoggerFactory struct {
writer io.Writer
defaultLogLevel LogLevel
scopeLevels map[string]LogLevel
}
var _ LoggerFactory = (*jsonLoggerFactory)(nil)
// JSONLoggerFactoryOption configures the JSON LoggerFactory.
type JSONLoggerFactoryOption func(*jsonLoggerFactory)
// WithJSONWriter overrides the writer used by JSON loggers.
func WithJSONWriter(writer io.Writer) JSONLoggerFactoryOption {
return func(factory *jsonLoggerFactory) {
if writer == nil {
factory.writer = os.Stderr
return
}
factory.writer = writer
}
}
// WithJSONDefaultLevel overrides the default log level used by JSON loggers.
func WithJSONDefaultLevel(level LogLevel) JSONLoggerFactoryOption {
return func(factory *jsonLoggerFactory) {
factory.defaultLogLevel = level
}
}
// WithJSONScopeLevels sets specific log levels for scopes, overriding env values.
func WithJSONScopeLevels(levels map[string]LogLevel) JSONLoggerFactoryOption {
return func(factory *jsonLoggerFactory) {
if levels == nil {
return
}
if factory.scopeLevels == nil {
factory.scopeLevels = make(map[string]LogLevel, len(levels))
}
for scope, level := range levels {
factory.scopeLevels[strings.ToLower(scope)] = level
}
}
}
// NewJSONLoggerFactory creates a new LoggerFactory that emits JSON logs.
func NewJSONLoggerFactory(options ...JSONLoggerFactoryOption) LoggerFactory {
factory := newJSONLoggerFactory()
for _, option := range options {
if option == nil {
continue
}
option(factory)
}
return factory
}
// newJSONLoggerFactory creates a new JSON LoggerFactory.
func newJSONLoggerFactory() *jsonLoggerFactory {
factory := jsonLoggerFactory{}
factory.defaultLogLevel = LogLevelError
factory.scopeLevels = make(map[string]LogLevel)
factory.writer = os.Stderr
logLevels := map[string]LogLevel{
"DISABLE": LogLevelDisabled,
"ERROR": LogLevelError,
"WARN": LogLevelWarn,
"INFO": LogLevelInfo,
"DEBUG": LogLevelDebug,
"TRACE": LogLevelTrace,
}
for name, level := range logLevels {
env := os.Getenv(fmt.Sprintf("PION_LOG_%s", name))
if env == "" {
env = os.Getenv(fmt.Sprintf("PIONS_LOG_%s", name))
}
if env == "" {
continue
}
if strings.ToLower(env) == "all" {
if factory.defaultLogLevel < level {
factory.defaultLogLevel = level
}
continue
}
scopes := strings.SplitSeq(strings.ToLower(env), ",")
for scope := range scopes {
factory.scopeLevels[scope] = level
}
}
return &factory
}
// NewLogger returns a configured JSON LeveledLogger for the given scope.
func (f *jsonLoggerFactory) NewLogger(scope string) LeveledLogger {
logLevel := f.defaultLogLevel
if f.scopeLevels != nil {
if scopeLevel, found := f.scopeLevels[scope]; found {
logLevel = scopeLevel
}
}
return newJSONLeveledLoggerForScope(scope, logLevel, f.writer)
}