README
¶
logging
Newreturns*slog.Logger.Helperwraps*slog.Logger.- Public package boundaries use
*slog.Logger. - App code may use
Helper.
Pass a non-nil context to each Helper logging call and to Enabled:
logger := logging.NewHelper(logging.New(logging.Options{
Level: logging.LevelInfo,
AddSource: true,
}))
logger = logger.With(logging.String("service", "accounts"))
logger.Info(ctx, "user saved", nil, logging.String("user_id", userID))
logger.Error(ctx, "save user failed", err, logging.String("user_id", userID))
Use the request context in handlers and context.Background() for startup logs.
The context reaches the underlying handler for filtering and output. A non-nil
error is appended as the error attribute. With keeps its own attribute slice.
AddSource includes the application call site in both text and JSON output.
Text output uses source=file:line; JSON output uses slog's source object.
Documentation
¶
Overview ¶
Package logging provides slog-based logging. Package logging 提供基于 slog 的日志。
Index ¶
- func Any(key string, value any) slog.Attr
- func Bool(key string, value bool) slog.Attr
- func Float64(key string, value float64) slog.Attr
- func Int(key string, value int) slog.Attr
- func Int64(key string, value int64) slog.Attr
- func New(opts Options) *slog.Logger
- func String(key, value string) slog.Attr
- func Time(key string, value time.Time) slog.Attr
- type Format
- type Helper
- func (h *Helper) Debug(ctx context.Context, msg string, err error, attrs ...slog.Attr)
- func (h *Helper) Enabled(ctx context.Context, level Level) bool
- func (h *Helper) Error(ctx context.Context, msg string, err error, attrs ...slog.Attr)
- func (h *Helper) Info(ctx context.Context, msg string, err error, attrs ...slog.Attr)
- func (h *Helper) Logger() *slog.Logger
- func (h *Helper) Warn(ctx context.Context, msg string, err error, attrs ...slog.Attr)
- func (h *Helper) With(attrs ...slog.Attr) *Helper
- type Level
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Format ¶
type Format string
Format is the log output format. Format 表示日志输出格式。
func ParseFormat ¶
ParseFormat parses `text` or `json`. ParseFormat 解析 `text` 或 `json`。
type Helper ¶ added in v0.1.5
type Helper struct {
// contains filtered or unexported fields
}
Helper wraps *slog.Logger with Error(ctx, msg, err, attrs...) style calls. Logging methods and Enabled require a non-nil context. Helper 用 Error(ctx, msg, err, attrs...) 形式包装 *slog.Logger。 日志方法和 Enabled 要求非 nil context。
func NewHelper ¶ added in v0.1.5
NewHelper returns a Helper for a base logger. Call NewHelper(base).Info(...) or NewHelper(base).Error(...). logger must not be nil. NewHelper 返回基于底层 logger 的 Helper。 调用 NewHelper(base).Info(...) 或 NewHelper(base).Error(...)。 logger 不能为空。
func (*Helper) Debug ¶ added in v0.1.5
Debug logs msg, err, and attrs at debug level. Debug 以 debug 级别记录 msg、err 和 attrs。
func (*Helper) Enabled ¶ added in v0.1.5
Enabled reports whether a level is enabled. Call Enabled before building expensive attrs. Enabled 返回某个级别是否启用。 在构造代价高的 attrs 前调用 Enabled。
func (*Helper) Error ¶ added in v0.1.5
Error logs msg, err, and attrs at error level. Error 以 error 级别记录 msg、err 和 attrs。
func (*Helper) Info ¶ added in v0.1.5
Info logs msg, err, and attrs at info level. Info 以 info 级别记录 msg、err 和 attrs。
func (*Helper) Logger ¶ added in v0.1.5
Logger returns the base logger. Use Logger() where an API requires *slog.Logger. Logger 返回底层 logger。 在某个 API 需要 *slog.Logger 时调用 Logger()。
type Level ¶
type Level int
Level is the log verbosity. Level 表示日志级别。
func ParseLevel ¶
ParseLevel parses `debug`, `info`, `warn`, or `error`. ParseLevel 解析 `debug`、`info`、`warn` 或 `error`。
Source Files