slog

README

slog

import "github.com/triple-a/gocom/database/pgx-slog"

Package slog provides a logger that writes to a go.uber.org/slog.Logger.

Index

• type Logger
  • func NewLogger(logger *slog.Logger) *Logger
  • func (pl *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, data map[string]any)

type Logger

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

func NewLogger

func NewLogger(logger *slog.Logger) *Logger

Example

package main

import (
	"context"
	"log/slog"

	"github.com/jackc/pgx/v5/pgxpool"
	"github.com/jackc/pgx/v5/tracelog"

	slogadapter "github.com/triple-a/gocom/database/pgx-slog"
)

func main() {
	textAdapter := slog.DiscardHandler
	logger := slog.New(textAdapter)

	pgxPool, _ := pgxpool.New(
		context.Background(),
		"postgres://postgres:postgres@localhost:5432/datawarehouse", // pragma: allowlist secret
	)

	pgxPool.Config().ConnConfig.Tracer = &tracelog.TraceLog{
		Logger:   slogadapter.NewLogger(logger),
		LogLevel: tracelog.LogLevelTrace,
	}
}

func (*Logger) Log

func (pl *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, data map[string]any)

Generated by gomarkdoc

Documentation

Overview

Package slog adapts pgx's tracelog.Logger to the standard library log/slog.

Index

• type Logger
  • func NewLogger(logger *slog.Logger) *Logger
  • func (pl *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, data map[string]any)

Examples

• NewLogger

Types

type Logger

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

Logger forwards pgx tracelog records to a *slog.Logger.

func NewLogger

func NewLogger(logger *slog.Logger) *Logger

NewLogger returns a Logger that forwards pgx tracelog records to logger.

Example

package main

import (
	"context"
	"log/slog"

	"github.com/jackc/pgx/v5/pgxpool"
	"github.com/jackc/pgx/v5/tracelog"

	slogadapter "github.com/triple-a/gocom/database/pgx-slog"
)

func main() {
	textAdapter := slog.DiscardHandler
	logger := slog.New(textAdapter)

	pgxPool, _ := pgxpool.New(
		context.Background(),
		"postgres://postgres:postgres@localhost:5432/datawarehouse", // pragma: allowlist secret
	)

	pgxPool.Config().ConnConfig.Tracer = &tracelog.TraceLog{
		Logger:   slogadapter.NewLogger(logger),
		LogLevel: tracelog.LogLevelTrace,
	}
}

func (*Logger) Log

func (pl *Logger) Log(
	ctx context.Context,
	level tracelog.LogLevel,
	msg string,
	data map[string]any,
)

Log implements tracelog.Logger by forwarding to the underlying *slog.Logger. LogLevelNone is honored as a no-op. Trace and undefined pgx levels are emitted at slog.LevelDebug and slog.LevelError respectively, with an extra PGX_LOG_LEVEL attribute identifying the original pgx level. Attributes are emitted in deterministic (sorted) key order.