logs

Documentation

Overview

logs 实现 slog 的 handler

没有很好的性能，只是在控制台上有人类友好的输出。对于日志性能高的场合请使用其他方案。

Index

• type Handler
  • func NewHandler(w io.Writer, opt *Options) *Handler
  • func (h *Handler) Enabled(_ context.Context, l slog.Level) bool
  • func (h *Handler) Handle(_ context.Context, r slog.Record) error
  • func (h *Handler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *Handler) WithGroup(name string) slog.Handler
• type Options
• type PrintFunc

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(w io.Writer, opt *Options) *Handler

func (*Handler) Enabled

func (h *Handler) Enabled(_ context.Context, l slog.Level) bool

Enabled reports whether the handler handles records at the given level. The handler ignores records whose level is lower. It is called early, before any arguments are processed, to save effort if the log event should be discarded. If called from a Logger method, the first argument is the context passed to that method, or context.Background() if nil was passed or the method does not take a context. The context is passed so Enabled can use its values to make a decision.

func (*Handler) Handle

func (h *Handler) Handle(_ context.Context, r slog.Record) error

Handle handles the Record. It will only be called when Enabled returns true. The Context argument is as for Enabled. It is present solely to provide Handlers access to the context's values. Canceling the context should not affect record processing. (Among other things, log messages may be necessary to debug a cancellation-related problem.)

Handle methods that produce output should observe the following rules:

• If r.Time is the zero time, ignore the time.
• If r.PC is zero, ignore it.
• Attr's values should be resolved.
• If an Attr's key and value are both the zero value, ignore the Attr. This can be tested with attr.Equal(Attr{}).
• If a group's key is empty, inline the group's Attrs.
• If a group has no Attrs (even if it has a non-empty key), ignore it.

func (*Handler) WithAttrs

func (h *Handler) WithAttrs(attrs []slog.Attr) slog.Handler

WithAttrs returns a new Handler whose attributes consist of both the receiver's attributes and the arguments. The Handler owns the slice: it may retain, modify or discard it.

func (*Handler) WithGroup

func (h *Handler) WithGroup(name string) slog.Handler

WithGroup returns a new Handler with the given group appended to the receiver's existing groups. The keys of all subsequent attributes, whether added by With or in a Record, should be qualified by the sequence of group names.

How this qualification happens is up to the Handler, so long as this Handler's attribute keys differ from those of another Handler with a different sequence of group names.

A Handler should treat WithGroup as starting a Group of Attrs that ends at the end of the log event. That is,

logger.WithGroup("s").LogAttrs(level, msg, slog.Int("a", 1), slog.Int("b", 2))

should behave like

logger.LogAttrs(level, msg, slog.Group("s", slog.Int("a", 1), slog.Int("b", 2)))

If the name is empty, WithGroup returns the receiver.

type Options

type Options struct {
	AddSource bool
	Level     slog.Leveler
	PrintFunc PrintFunc
}

选项

type PrintFunc

type PrintFunc func(t time.Time, Level slog.Level, source *runtime.Frame, msg string, attr []slog.Attr) string

PrintFunc 用于单条对日志生成字符串