ctxlog

README

ctxlog

An agnostic, context-based wrapper for loggers. Adapted from the package of the same name by Zikaeroh.

By default, ctxlog comes with support for the following out of the box:

• zap's standard Logger.
• log/slog's Logger.

Using

zap

import (
    "context"

    "github.com/holedaemon/ctxlog"
    "github.com/holedaemon/ctxlog/ctxzap"
)

func main() {
    logger := ctxzap.New(false, nil)
    ctx := ctxlog.WithLogger(context.Background(), logger)

    ctxlog.Info(ctx, "hello", zap.String("cool", "argument"))
}

log/slog

import (
    "context"

    "github.com/holedaemon/ctxlog"
    "github.com/holedaemon/ctxlog/ctxslog"
)

func main() {
    logger := ctxslog.New(false, nil)
    ctx := ctxlog.WithLogger(context.Background(), logger)

    ctxlog.Info(ctx, "hello", "cool", "arg")
    ctxlog.Info(ctx, "hello", slog.String("cool", "arg"))
}

Extending

If you want to extend ctxlog to support a different logger, ctxlog exposes the Logger interface, which can be implemented.

type Logger interface {
    Debug(msg string, fields ...any)
    Info(msg string, fields ...any)
    Warn(msg string, fields ...any)
    Error(msg string, fields ...any)
    Fatal(msg string, fields ...any)
}

LICENSE

LICENSE

Documentation

Index

• func Debug(ctx context.Context, msg string, fields ...any)
• func Error(ctx context.Context, msg string, fields ...any)
• func Fatal(ctx context.Context, msg string, fields ...any)
• func Info(ctx context.Context, msg string, fields ...any)
• func Warn(ctx context.Context, msg string, fields ...any)
• func WithLogger(ctx context.Context, logger Logger) context.Context
• type Logger
  • func FromContext(ctx context.Context) Logger

Functions

func Debug

func Debug(ctx context.Context, msg string, fields ...any)

Debug logs at the debug level.

func Error

func Error(ctx context.Context, msg string, fields ...any)

Error logs at the error level.

func Fatal

func Fatal(ctx context.Context, msg string, fields ...any)

Fatal logs at the fatal level.

func Info

func Info(ctx context.Context, msg string, fields ...any)

Info logs at the info level.

func Warn

func Warn(ctx context.Context, msg string, fields ...any)

Warn logs at the warn level.

func WithLogger

func WithLogger(ctx context.Context, logger Logger) context.Context

WithLogger adds a logger to the given context.

Types

type Logger

type Logger interface {
	Debug(msg string, fields ...any)
	Info(msg string, fields ...any)
	Warn(msg string, fields ...any)
	Error(msg string, fields ...any)
	Fatal(msg string, fields ...any)
}

Logger represents a logger that is used by ctxlog.

func FromContext

func FromContext(ctx context.Context) Logger

FromContext retrieves a logger from the given context. If the context does not contain a logger, a nop logger is returned.