logz

README

ezpkg.io/logz

Package logz provides common interfaces and utilities for working with other log packages, including log/slog and zap. It's useful for package library to provide a common interface for logging, so that the user can choose the logging package they want to use.

Installation

go get -u ezpkg.io/logz@v0.1.2

Examples

package mypackage

import "log/slog"
import "os"
import "testing"
import "go.uber.org/zap"

import "ezpkg.io/errorz"
import "ezpkg.io/logz"

type SuperPower struct {
	logger logz.Logger
}

func NewSuperPower(logger logz.Logger) (*SuperPower, error) {
	sp := &SuperPower{logger: logger}
	sp.logger.Debugw("A new SuperPower is created! Better be prepared! 🔥")
	return sp, nil
}

func TestSuperPowerUsingSlog(t *testing.T) {
	opt := &slog.HandlerOptions{Level: slog.LevelDebug}
	handler := slog.NewTextHandler(os.Stderr, opt)
	stdLogger := slog.New(handler)

	sp, err := NewSuperPower(logz.FromLoggerI(stdLogger))
	assertSuperPower(sp, err)
}
func TestSuperPowerUsingZap(t *testing.T) {
	zapLogger := errorz.Must(zap.NewDevelopment()).Sugar()

	sp, err := NewSuperPower(logz.FromLoggerx(zapLogger))
	assertSuperPower(sp, err)
}

About ezpkg.io

As I work on various Go projects, I often find myself creating utility functions, extending existing packages, or developing packages to solve specific problems. Moving from one project to another, I usually have to copy or rewrite these solutions. So I created this repository to have all these utilities and packages in one place. Hopefully, you'll find them useful as well.

For more information, see the main repository.

Author

  

Documentation

Overview

Package logz provides common interfaces and utilities for working with other log packages, including log/slog and zap.

Index

• Constants
• func FormatLevelColor(opt *FormatLevelColorOptions) func([]byte, Level) []byte
• func SetDefaultEnableLevel(level Level)
• type Attr
• type CtxEnabler
• type CtxEnablerFunc
  • func (fn CtxEnablerFunc) Enabled(ctx context.Context, level Level) bool
• type Enabler
• type EnablerFunc
  • func (fn EnablerFunc) Enabled(level Level) bool
• type FormatLevelColorOptions
• type Handler
  • func NewTextHandler(w io.Writer, opt *TextHandlerOptions) Handler
• type Level
  • func GetDefaultEnableLevel() Level
• type LevelVar
  • func DefaultLevelVar() *LevelVar
• type Leveler
• type Logger
  • func DefaultLogger(w io.Writer) Logger
  • func FromLoggerI(logger LoggerI) Logger
  • func FromLoggerP(logger LoggerP) Logger
  • func FromLoggerf(logger Loggerf) Logger
  • func FromLoggerw(logger Loggerw) Logger
  • func FromLoggerx(logger Loggerx) Logger
  • func New(h Handler) Logger
• type LoggerI
• type LoggerP
• type Loggerf
• type Loggerw
• type Loggerx
• type Option
  • func WithCtxEnabler(enablerFunc CtxEnablerFunc) Option
  • func WithEnabler(enabler EnablerFunc) Option
  • func WithLevel(level Level) Option
  • func WithLeveler(level Leveler) Option
  • func (o Option) FromLoggerI(logger LoggerI) Logger
  • func (o Option) FromLoggerP(logger LoggerP) Logger
  • func (o Option) FromLoggerf(logger Loggerf) Logger
  • func (o Option) FromLoggerw(logger Loggerw) Logger
  • func (o Option) FromLoggerx(logger Loggerx) Logger
  • func (o Option) WithCtxEnabler(enabler CtxEnablerFunc) Option
  • func (o Option) WithEnabler(enabler EnablerFunc) Option
  • func (o Option) WithLevel(level Level) Option
  • func (o Option) WithLeveler(level Leveler) Option
• type TextHandlerOptions
  • func (o TextHandlerOptions) ToSlogOptions() slog.HandlerOptions

Constants

const (
	LevelDebug = slog.LevelDebug
	LevelInfo  = slog.LevelInfo
	LevelWarn  = slog.LevelWarn
	LevelError = slog.LevelError
)

Functions

func FormatLevelColor

func FormatLevelColor(opt *FormatLevelColorOptions) func([]byte, Level) []byte

func SetDefaultEnableLevel

func SetDefaultEnableLevel(level Level)

Types

type Attr

type Attr = slog.Attr

type CtxEnabler

type CtxEnabler interface {
	Enabled(ctx context.Context, level Level) bool
}

type CtxEnablerFunc

type CtxEnablerFunc func(ctx context.Context, level Level) bool

func (CtxEnablerFunc) Enabled

func (fn CtxEnablerFunc) Enabled(ctx context.Context, level Level) bool

type Enabler

type Enabler interface {
	Enabled(level Level) bool
}

type EnablerFunc

type EnablerFunc func(level Level) bool

func (EnablerFunc) Enabled

func (fn EnablerFunc) Enabled(level Level) bool

type FormatLevelColorOptions

type FormatLevelColorOptions struct {
	DebugColor string // colorz.Magenta.Code()
	InfoColor  string // colorz.Cyan.Code()
	WarnColor  string // colorz.Yellow.Code()
	ErrorColor string // colorz.Red.Code()
}

type Handler

type Handler = slog.Handler

func NewTextHandler

func NewTextHandler(w io.Writer, opt *TextHandlerOptions) Handler

type Level

type Level = slog.Level

func GetDefaultEnableLevel

func GetDefaultEnableLevel() Level

type LevelVar

type LevelVar = slog.LevelVar

func DefaultLevelVar

func DefaultLevelVar() *LevelVar

type Leveler

type Leveler = slog.Leveler

type Logger

type Logger interface {
	Debugw(msg string, keyValues ...any)
	Infow(msg string, keyValues ...any)
	Warnw(msg string, keyValues ...any)
	Errorw(msg string, keyValues ...any)

	Debugf(format string, args ...any)
	Infof(format string, args ...any)
	Warnf(format string, args ...any)
	Errorf(format string, args ...any)

	Enabled(ctx context.Context, level Level) bool
	With(keyValues ...any) Logger
}

func DefaultLogger

func DefaultLogger(w io.Writer) Logger

func FromLoggerI

func FromLoggerI(logger LoggerI) Logger

func FromLoggerP

func FromLoggerP(logger LoggerP) Logger

func FromLoggerf

func FromLoggerf(logger Loggerf) Logger

func FromLoggerw

func FromLoggerw(logger Loggerw) Logger

func FromLoggerx

func FromLoggerx(logger Loggerx) Logger

func New

func New(h Handler) Logger

type LoggerI

type LoggerI interface {
	Debug(msg string, keyValues ...any)
	Info(msg string, keyValues ...any)
	Warn(msg string, keyValues ...any)
	Error(msg string, keyValues ...any)
}

LoggerI is implemented by stdlib slog.Logger.

type LoggerP

type LoggerP interface {
	Printf(format string, args ...any)
}

LoggerP is implemented by stdlib log.Logger.

type Loggerf

type Loggerf interface {
	Debugf(format string, args ...any)
	Infof(format string, args ...any)
	Warnf(format string, args ...any)
	Errorf(format string, args ...any)
}

type Loggerw

type Loggerw interface {
	Debugw(msg string, keyValues ...any)
	Infow(msg string, keyValues ...any)
	Warnw(msg string, keyValues ...any)
	Errorw(msg string, keyValues ...any)
}

Loggerw is implemented by zap.SugaredLogger.

type Loggerx

type Loggerx interface {
	Loggerw
	Loggerf
}

type Option

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

func WithCtxEnabler

func WithCtxEnabler(enablerFunc CtxEnablerFunc) Option

func WithEnabler

func WithEnabler(enabler EnablerFunc) Option

func WithLevel

func WithLevel(level Level) Option

func WithLeveler

func WithLeveler(level Leveler) Option

func (Option) FromLoggerI

func (o Option) FromLoggerI(logger LoggerI) Logger

func (Option) FromLoggerP

func (o Option) FromLoggerP(logger LoggerP) Logger

func (Option) FromLoggerf

func (o Option) FromLoggerf(logger Loggerf) Logger

func (Option) FromLoggerw

func (o Option) FromLoggerw(logger Loggerw) Logger

func (Option) FromLoggerx

func (o Option) FromLoggerx(logger Loggerx) Logger

func (Option) WithCtxEnabler

func (o Option) WithCtxEnabler(enabler CtxEnablerFunc) Option

func (Option) WithEnabler

func (o Option) WithEnabler(enabler EnablerFunc) Option

func (Option) WithLevel

func (o Option) WithLevel(level Level) Option

func (Option) WithLeveler

func (o Option) WithLeveler(level Leveler) Option

type TextHandlerOptions

type TextHandlerOptions struct {
	AddSource bool // TODO
	Level     Leveler

	FormatTime  func(b []byte, time time.Time) []byte
	FormatLevel func(b []byte, level Level) []byte
}

func (TextHandlerOptions) ToSlogOptions

func (o TextHandlerOptions) ToSlogOptions() slog.HandlerOptions