sloggorm

README

slog-gorm

Gorm Logger implemented with slog, inspired by orandin/slog-gorm with my own ideas to tailor it to my specific needs.

🚀 Install

go get github.com/imdatngo/slog-gorm/v2

Compatibility: go >= 1.21

💡 Usage

Minimal

See config.go for default values.

import (
	"gorm.io/driver/sqlite"
	"gorm.io/gorm"

	sloggorm "github.com/imdatngo/slog-gorm/v2"
)

// Create new slog-gorm instance with slog.Default()
glogger := sloggorm.New()

// Global mode
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{
	Logger: glogger,
})

// Continuous session mode
tx := db.Session(&gorm.Session{Logger: glogger})
tx.First(&user)
tx.Model(&user).Update("Age", 18)

// Sample output:
// 2024/04/16 07:30:00 ERROR Query ERROR duration=128.364µs rows=0 file=main.go:45 error="record not found" query="SELECT * FROM `users` ORDER BY `users`.`id` LIMIT 1"
// 2024/04/16 07:30:00 WARN Query SLOW duration=133.448µs rows=0 file=main.go:46 slow_threshold=100ns query="UPDATE `users` SET `age`=18 WHERE `id` = 1"

With config

// Your slog.Logger instance
slogger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelInfo}))

// Create new slog-gorm instance with custom config
cfg := sloggorm.NewConfig(slogger.Handler()).
	WithGroupKey("db").
	WithSlowThreshold(time.Second).
	WithIgnoreRecordNotFoundError(true).
	WithTraceAll(true)
glogger := sloggorm.NewWithConfig(cfg)

// Sample output:
// time=2024-04-16T07:35:40.696Z level=INFO msg="Query OK" db.duration=130.659µs db.rows=1 db.file=main.go:45 db.query="SELECT * FROM `users` WHERE `users`.`id` = 1 ORDER BY `users`.`id` LIMIT 1"
// time=2024-04-16T07:35:40.697Z level=INFO msg="Query OK" db.duration=940.445µs db.rows=1 db.file=main.go:46 db.query="UPDATE `users` SET `age`=18 WHERE `id` = 1"

With Context

When you got the context keys:

cfg.WithContextKeys(map[string]any{
	"trace_id": pkg.TraceIdCtxKey,
	"span_id":  pkg.SpanIdCtxKey,
	"service": "serviceName", // built-in type is not recommended though
})

or when some packages have it own extractor:

cfg.WithContextExtractor(func(ctx context.Context) []slog.Attr {
	tracer := pkg.FromContext(ctx)
	return []slog.Attr{
		// group the context attributes as needed
		slog.Group("ctx",
			slog.String("trace_id", tracer.TraceId),
			slog.String("span_id", tracer.SpanId),
			slog.String("service", mypkg.FromCtx(ctx)),
		),
	}
})

// Sample output:
// time=2024-05-05T22:23:24.345Z level=INFO msg="Query OK" ctx.trace_id=014KG56DC01GG4TEB01ZEX7WFJ ctx.span_id=014KG56DC01GG4TEB022Z17KKS ctx.service=users db.duration=139.007µs db.rows=1 db.file=main.go:69 db.query="SELECT * FROM `users` WHERE `users`.`id` = 1 ORDER BY `users`.`id` LIMIT 1"
// time=2024-05-05T22:23:24.678Z level=INFO msg="Query OK" ctx.trace_id=014KG56DC01GG4TEB01ZEX7WFJ ctx.span_id=014KG56DC01GG4TEB022Z17KKS ctx.service=users db.duration=915.688µs db.rows=1 db.file=main.go:70 db.query="UPDATE `users` SET `age`=18 WHERE `id` = 1"

Silence!

The slow queries and errors are logged by default, to discard all logs:

cfg := sloggorm.NewConfig(slogger.Handler()).WithSilent(true)
glogger := sloggorm.NewWithConfig(cfg)

To on/off in session mode:

// Start gorm's debug mode which is equivalent to cfg.WithTraceAll(true)
db.Debug().First(&User{})
// similar to new session
newLogger := glogger.LogMode(gormlogger.Info)
tx := db.Session(&gorm.Session{Logger: newLogger})

// or discard all logs for a session
tx := db.Session(&gorm.Session{Logger: db.Logger.LogMode(gormlogger.Silent)})

Documentation

Index

• func New() *logger
• func NewConfig(h slog.Handler) *config
• func NewWithConfig(config *config) *logger

Functions

func New

func New() *logger

New creates a new logger with default config

func NewConfig

func NewConfig(h slog.Handler) *config

NewConfig creates a new config with the given non-nil slog.Handler

func NewWithConfig

func NewWithConfig(config *config) *logger

NewWithConfig creates a new logger with given config