ttys3/slogx

Simple slog wrapper for easy life, with opentelemetry tracing support

slogx

log/slog stdlib requires go version >= 1.21.0

slog handler with opentelemetry tracing support and simple init helper method

trace_id in log

added Apex log cli handler like handler (impl ref https://github.com/apex/log/blob/master/handlers/cli/cli.go)

usage

package main

import (
    "context"
    "github.com/ttys3/slogx"
    "github.com/ttys3/tracing-go"
    "go.opentelemetry.io/otel"
    "log/slog"
    "io"
)

func main() {
	// init a new slog json handler at info level with output to stderr
	// and wrap it within a tracing handler
	logger := slogx.New(slogx.WithTracing())
	slog.SetDefault(logger)

	ctx := context.Background()

	// set up a recording tracer, non-recording span will not get a trace_id
	tpShutdown, err := tracing.InitProvider(ctx, tracing.WithStdoutTrace())
	if err != nil {
		panic(err)
	}
	defer tpShutdown(context.Background())

	ctx, newSpan := otel.Tracer("my-tracer-name").Start(ctx, "hello.Slog")
	defer newSpan.End()
	log := slog.With("user_id", 123456)
	// no trace_id in log
	log.Info("hello world")

	// has trace_id in log
	log.With("foo", "bar").ErrorContext(ctx, "have a nice day", "err", io.ErrClosedPipe)
	log.ErrorContext(ctx, "example error", "err", io.ErrClosedPipe)
}

related projects

slog.Handler that writes tinted logs https://github.com/lmittmann/tint/

Example ConsoleHandler for slog Logger https://gist.github.com/wijayaerick/de3de10c47a79d5310968ba5ff101a19

slogx's Issues

a better wrapper

since slog api changed, and has WithContext method and Ctx method removed, and add some bad InfoCtx like method.

we need a better wrapper.

console logger with apex liked colored level encoder

maybe ref https://gist.github.com/ttys3/5d05e5eb8cda55d0795b83b2df78d083

or https://github.com/charmbracelet/log/blob/main/level.go

use Package `slogtest` for testing implementations of log/slog.Handler

use Package slogtest for testing implementations of log/slog.Handler

https://pkg.go.dev/testing/slogtest