1 // Copyright 2022 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
11 "log/slog/internal/buffer"
18 // A Handler handles log records produced by a Logger..
20 // A typical handler may print log records to standard error,
21 // or write them to a file or database, or perhaps augment them
22 // with additional attributes and pass them on to another handler.
24 // Any of the Handler's methods may be called concurrently with itself
25 // or with other methods. It is the responsibility of the Handler to
26 // manage this concurrency.
28 // Users of the slog package should not invoke Handler methods directly.
29 // They should use the methods of [Logger] instead.
30 type Handler interface {
31 // Enabled reports whether the handler handles records at the given level.
32 // The handler ignores records whose level is lower.
33 // It is called early, before any arguments are processed,
34 // to save effort if the log event should be discarded.
35 // If called from a Logger method, the first argument is the context
36 // passed to that method, or context.Background() if nil was passed
37 // or the method does not take a context.
38 // The context is passed so Enabled can use its values
39 // to make a decision.
40 Enabled(context.Context, Level) bool
42 // Handle handles the Record.
43 // It will only be called when Enabled returns true.
44 // The Context argument is as for Enabled.
45 // It is present solely to provide Handlers access to the context's values.
46 // Canceling the context should not affect record processing.
47 // (Among other things, log messages may be necessary to debug a
48 // cancellation-related problem.)
50 // Handle methods that produce output should observe the following rules:
51 // - If r.Time is the zero time, ignore the time.
52 // - If r.PC is zero, ignore it.
53 // - Attr's values should be resolved.
54 // - If an Attr's key and value are both the zero value, ignore the Attr.
55 // This can be tested with attr.Equal(Attr{}).
56 // - If a group's key is empty, inline the group's Attrs.
57 // - If a group has no Attrs (even if it has a non-empty key),
59 Handle(context.Context, Record) error
61 // WithAttrs returns a new Handler whose attributes consist of
62 // both the receiver's attributes and the arguments.
63 // The Handler owns the slice: it may retain, modify or discard it.
64 WithAttrs(attrs []Attr) Handler
66 // WithGroup returns a new Handler with the given group appended to
67 // the receiver's existing groups.
68 // The keys of all subsequent attributes, whether added by With or in a
69 // Record, should be qualified by the sequence of group names.
71 // How this qualification happens is up to the Handler, so long as
72 // this Handler's attribute keys differ from those of another Handler
73 // with a different sequence of group names.
75 // A Handler should treat WithGroup as starting a Group of Attrs that ends
76 // at the end of the log event. That is,
78 // logger.WithGroup("s").LogAttrs(level, msg, slog.Int("a", 1), slog.Int("b", 2))
82 // logger.LogAttrs(level, msg, slog.Group("s", slog.Int("a", 1), slog.Int("b", 2)))
84 // If the name is empty, WithGroup returns the receiver.
85 WithGroup(name string) Handler
88 type defaultHandler struct {
90 // internal.DefaultOutput, except for testing
91 output func(pc uintptr, data []byte) error
94 func newDefaultHandler(output func(uintptr, []byte) error) *defaultHandler {
95 return &defaultHandler{
96 ch: &commonHandler{json: false},
101 func (*defaultHandler) Enabled(_ context.Context, l Level) bool {
102 return l >= LevelInfo
105 // Collect the level, attributes and message in a string and
106 // write it with the default log.Logger.
107 // Let the log.Logger handle time and file/line.
108 func (h *defaultHandler) Handle(ctx context.Context, r Record) error {
110 buf.WriteString(r.Level.String())
112 buf.WriteString(r.Message)
113 state := h.ch.newHandleState(buf, true, " ")
115 state.appendNonBuiltIns(r)
116 return h.output(r.PC, *buf)
119 func (h *defaultHandler) WithAttrs(as []Attr) Handler {
120 return &defaultHandler{h.ch.withAttrs(as), h.output}
123 func (h *defaultHandler) WithGroup(name string) Handler {
124 return &defaultHandler{h.ch.withGroup(name), h.output}
127 // HandlerOptions are options for a TextHandler or JSONHandler.
128 // A zero HandlerOptions consists entirely of default values.
129 type HandlerOptions struct {
130 // AddSource causes the handler to compute the source code position
131 // of the log statement and add a SourceKey attribute to the output.
134 // Level reports the minimum record level that will be logged.
135 // The handler discards records with lower levels.
136 // If Level is nil, the handler assumes LevelInfo.
137 // The handler calls Level.Level for each record processed;
138 // to adjust the minimum level dynamically, use a LevelVar.
141 // ReplaceAttr is called to rewrite each non-group attribute before it is logged.
142 // The attribute's value has been resolved (see [Value.Resolve]).
143 // If ReplaceAttr returns an Attr with Key == "", the attribute is discarded.
145 // The built-in attributes with keys "time", "level", "source", and "msg"
146 // are passed to this function, except that time is omitted
147 // if zero, and source is omitted if AddSource is false.
149 // The first argument is a list of currently open groups that contain the
150 // Attr. It must not be retained or modified. ReplaceAttr is never called
151 // for Group attributes, only their contents. For example, the attribute
154 // Int("a", 1), Group("g", Int("b", 2)), Int("c", 3)
156 // results in consecutive calls to ReplaceAttr with the following arguments:
159 // []string{"g"}, Int("b", 2)
162 // ReplaceAttr can be used to change the default keys of the built-in
163 // attributes, convert types (for example, to replace a `time.Time` with the
164 // integer seconds since the Unix epoch), sanitize personal information, or
165 // remove attributes from the output.
166 ReplaceAttr func(groups []string, a Attr) Attr
169 // Keys for "built-in" attributes.
171 // TimeKey is the key used by the built-in handlers for the time
172 // when the log method is called. The associated Value is a [time.Time].
174 // LevelKey is the key used by the built-in handlers for the level
175 // of the log call. The associated value is a [Level].
177 // MessageKey is the key used by the built-in handlers for the
178 // message of the log call. The associated value is a string.
180 // SourceKey is the key used by the built-in handlers for the source file
181 // and line of the log call. The associated value is a string.
185 type commonHandler struct {
186 json bool // true => output JSON; false => output text
188 preformattedAttrs []byte
189 // groupPrefix is for the text handler only.
190 // It holds the prefix for groups that were already pre-formatted.
191 // A group will appear here when a call to WithGroup is followed by
192 // a call to WithAttrs.
194 groups []string // all groups started from WithGroup
195 nOpenGroups int // the number of groups opened in preformattedAttrs
200 func (h *commonHandler) clone() *commonHandler {
201 // We can't use assignment because we can't copy the mutex.
202 return &commonHandler{
205 preformattedAttrs: slices.Clip(h.preformattedAttrs),
206 groupPrefix: h.groupPrefix,
207 groups: slices.Clip(h.groups),
208 nOpenGroups: h.nOpenGroups,
213 // enabled reports whether l is greater than or equal to the
215 func (h *commonHandler) enabled(l Level) bool {
216 minLevel := LevelInfo
217 if h.opts.Level != nil {
218 minLevel = h.opts.Level.Level()
223 func (h *commonHandler) withAttrs(as []Attr) *commonHandler {
225 // Pre-format the attributes as an optimization.
226 state := h2.newHandleState((*buffer.Buffer)(&h2.preformattedAttrs), false, "")
228 state.prefix.WriteString(h.groupPrefix)
229 if len(h2.preformattedAttrs) > 0 {
230 state.sep = h.attrSep()
233 for _, a := range as {
236 // Remember the new prefix for later keys.
237 h2.groupPrefix = state.prefix.String()
238 // Remember how many opened groups are in preformattedAttrs,
239 // so we don't open them again when we handle a Record.
240 h2.nOpenGroups = len(h2.groups)
244 func (h *commonHandler) withGroup(name string) *commonHandler {
246 h2.groups = append(h2.groups, name)
250 func (h *commonHandler) handle(r Record) error {
251 state := h.newHandleState(buffer.New(), true, "")
254 state.buf.WriteByte('{')
256 // Built-in attributes. They are not in a group.
257 stateGroups := state.groups
258 state.groups = nil // So ReplaceAttrs sees no groups instead of the pre groups.
259 rep := h.opts.ReplaceAttr
261 if !r.Time.IsZero() {
263 val := r.Time.Round(0) // strip monotonic to match Attr behavior
266 state.appendTime(val)
268 state.appendAttr(Time(key, val))
276 state.appendString(val.String())
278 state.appendAttr(Any(key, val))
281 if h.opts.AddSource {
282 state.appendAttr(Any(SourceKey, r.source()))
288 state.appendString(msg)
290 state.appendAttr(String(key, msg))
292 state.groups = stateGroups // Restore groups passed to ReplaceAttrs.
293 state.appendNonBuiltIns(r)
294 state.buf.WriteByte('\n')
298 _, err := h.w.Write(*state.buf)
302 func (s *handleState) appendNonBuiltIns(r Record) {
303 // preformatted Attrs
304 if len(s.h.preformattedAttrs) > 0 {
305 s.buf.WriteString(s.sep)
306 s.buf.Write(s.h.preformattedAttrs)
307 s.sep = s.h.attrSep()
309 // Attrs in Record -- unlike the built-in ones, they are in groups started
311 s.prefix.WriteString(s.h.groupPrefix)
313 r.Attrs(func(a Attr) bool {
318 // Close all open groups.
319 for range s.h.groups {
322 // Close the top-level object.
327 // attrSep returns the separator between attributes.
328 func (h *commonHandler) attrSep() string {
335 // handleState holds state for a single call to commonHandler.handle.
336 // The initial value of sep determines whether to emit a separator
337 // before the next key, after which it stays true.
338 type handleState struct {
341 freeBuf bool // should buf be freed?
342 sep string // separator to write before next key
343 prefix *buffer.Buffer // for text: key prefix
344 groups *[]string // pool-allocated slice of active groups, for ReplaceAttr
347 var groupPool = sync.Pool{New: func() any {
348 s := make([]string, 0, 10)
352 func (h *commonHandler) newHandleState(buf *buffer.Buffer, freeBuf bool, sep string) handleState {
358 prefix: buffer.New(),
360 if h.opts.ReplaceAttr != nil {
361 s.groups = groupPool.Get().(*[]string)
362 *s.groups = append(*s.groups, h.groups[:h.nOpenGroups]...)
367 func (s *handleState) free() {
371 if gs := s.groups; gs != nil {
378 func (s *handleState) openGroups() {
379 for _, n := range s.h.groups[s.h.nOpenGroups:] {
384 // Separator for group names and keys.
385 const keyComponentSep = '.'
387 // openGroup starts a new group of attributes
388 // with the given name.
389 func (s *handleState) openGroup(name string) {
395 s.prefix.WriteString(name)
396 s.prefix.WriteByte(keyComponentSep)
398 // Collect group names for ReplaceAttr.
400 *s.groups = append(*s.groups, name)
404 // closeGroup ends the group with the given name.
405 func (s *handleState) closeGroup(name string) {
409 (*s.prefix) = (*s.prefix)[:len(*s.prefix)-len(name)-1 /* for keyComponentSep */]
411 s.sep = s.h.attrSep()
413 *s.groups = (*s.groups)[:len(*s.groups)-1]
417 // appendAttr appends the Attr's key and value using app.
418 // It handles replacement and checking for an empty key.
419 // after replacement).
420 func (s *handleState) appendAttr(a Attr) {
421 if rep := s.h.opts.ReplaceAttr; rep != nil && a.Value.Kind() != KindGroup {
426 // Resolve before calling ReplaceAttr, so the user doesn't have to.
427 a.Value = a.Value.Resolve()
430 a.Value = a.Value.Resolve()
431 // Elide empty Attrs.
435 // Special case: Source.
436 if v := a.Value; v.Kind() == KindAny {
437 if src, ok := v.Any().(*Source); ok {
439 a.Value = src.group()
441 a.Value = StringValue(fmt.Sprintf("%s:%d", src.File, src.Line))
445 if a.Value.Kind() == KindGroup {
446 attrs := a.Value.Group()
447 // Output only non-empty groups.
449 // Inline a group with an empty key.
453 for _, aa := range attrs {
462 s.appendValue(a.Value)
466 func (s *handleState) appendError(err error) {
467 s.appendString(fmt.Sprintf("!ERROR:%v", err))
470 func (s *handleState) appendKey(key string) {
471 s.buf.WriteString(s.sep)
472 if s.prefix != nil && len(*s.prefix) > 0 {
473 // TODO: optimize by avoiding allocation.
474 s.appendString(string(*s.prefix) + key)
483 s.sep = s.h.attrSep()
486 func (s *handleState) appendString(str string) {
489 *s.buf = appendEscapedJSONString(*s.buf, str)
493 if needsQuoting(str) {
494 *s.buf = strconv.AppendQuote(*s.buf, str)
496 s.buf.WriteString(str)
501 func (s *handleState) appendValue(v Value) {
504 err = appendJSONValue(s, v)
506 err = appendTextValue(s, v)
513 func (s *handleState) appendTime(t time.Time) {
517 writeTimeRFC3339Millis(s.buf, t)
521 // This takes half the time of Time.AppendFormat.
522 func writeTimeRFC3339Millis(buf *buffer.Buffer, t time.Time) {
523 year, month, day := t.Date()
524 buf.WritePosIntWidth(year, 4)
526 buf.WritePosIntWidth(int(month), 2)
528 buf.WritePosIntWidth(day, 2)
530 hour, min, sec := t.Clock()
531 buf.WritePosIntWidth(hour, 2)
533 buf.WritePosIntWidth(min, 2)
535 buf.WritePosIntWidth(sec, 2)
538 buf.WritePosIntWidth(ns/1e6, 3)
539 _, offsetSeconds := t.Zone()
540 if offsetSeconds == 0 {
543 offsetMinutes := offsetSeconds / 60
544 if offsetMinutes < 0 {
546 offsetMinutes = -offsetMinutes
550 buf.WritePosIntWidth(offsetMinutes/60, 2)
552 buf.WritePosIntWidth(offsetMinutes%60, 2)