log

Documentation

Index

• func ContextWithNewID(ctx context.Context) context.Context
• func ContextWithOverrideLevel(ctx context.Context, level Level) context.Context
• func Debug(args ...any)
• func DebugContext(ctx context.Context, args ...any)
• func Error(args ...any)
• func ErrorContext(ctx context.Context, args ...any)
• func Fatal(args ...any)
• func FatalContext(ctx context.Context, args ...any)
• func FormatLevel(level Level) string
• func Info(args ...any)
• func InfoContext(ctx context.Context, args ...any)
• func Panic(args ...any)
• func PanicContext(ctx context.Context, args ...any)
• func SetStdLogger(logger ContextLogger)
• func Trace(args ...any)
• func TraceContext(ctx context.Context, args ...any)
• func Warn(args ...any)
• func WarnContext(ctx context.Context, args ...any)
• type ContextLogger
  • func StdLogger() ContextLogger
• type Entry
• type Factory
  • func New(options Options) (Factory, error)
• type Formatter
  • func (f Formatter) Format(ctx context.Context, level Level, tag string, message string, ...) string
  • func (f Formatter) FormatWithSimple(ctx context.Context, level Level, tag string, message string, ...) (string, string)
• type ID
  • func IDFromContext(ctx context.Context) (ID, bool)
• type Level
  • func OverrideLevelFromContext(origin Level, ctx context.Context) Level
  • func ParseLevel(level string) (Level, error)
• type Logger
• type ObservableFactory
  • func NewDefaultFactory(ctx context.Context, formatter Formatter, writer io.Writer, filePath string, ...) ObservableFactory
  • func NewNOPFactory() ObservableFactory
• type Options
• type PlatformWriter

Functions

func ContextWithNewID

func ContextWithNewID(ctx context.Context) context.Context

func ContextWithOverrideLevel

func ContextWithOverrideLevel(ctx context.Context, level Level) context.Context

func Debug

func Debug(args ...any)

func DebugContext

func DebugContext(ctx context.Context, args ...any)

func Error

func Error(args ...any)

func ErrorContext

func ErrorContext(ctx context.Context, args ...any)

func Fatal

func Fatal(args ...any)

func FatalContext

func FatalContext(ctx context.Context, args ...any)

func FormatLevel

func FormatLevel(level Level) string

func Info

func Info(args ...any)

func InfoContext

func InfoContext(ctx context.Context, args ...any)

func Panic

func Panic(args ...any)

func PanicContext

func PanicContext(ctx context.Context, args ...any)

func SetStdLogger

func SetStdLogger(logger ContextLogger)

func Trace

func Trace(args ...any)

func TraceContext

func TraceContext(ctx context.Context, args ...any)

func Warn

func Warn(args ...any)

func WarnContext

func WarnContext(ctx context.Context, args ...any)

Types

type ContextLogger

type ContextLogger logger.ContextLogger

func StdLogger

func StdLogger() ContextLogger

type Entry

type Entry struct {
	Level   Level
	Message string
}

type Factory

type Factory interface {
	Start() error
	Close() error
	Level() Level
	SetLevel(level Level)
	Logger() ContextLogger
	NewLogger(tag string) ContextLogger
}

func New

func New(options Options) (Factory, error)

type Formatter

type Formatter struct {
	BaseTime         time.Time
	DisableColors    bool
	DisableTimestamp bool
	FullTimestamp    bool
	TimestampFormat  string
	DisableLineBreak bool
}

func (Formatter) Format

func (f Formatter) Format(ctx context.Context, level Level, tag string, message string, timestamp time.Time) string

func (Formatter) FormatWithSimple

func (f Formatter) FormatWithSimple(ctx context.Context, level Level, tag string, message string, timestamp time.Time) (string, string)

type ID

type ID struct {
	ID        uint32
	CreatedAt time.Time
}

func IDFromContext

func IDFromContext(ctx context.Context) (ID, bool)

type Level

type Level = uint8

const (
	LevelPanic Level = iota
	LevelFatal
	LevelError
	LevelWarn
	LevelInfo
	LevelDebug
	LevelTrace
)

func OverrideLevelFromContext

func OverrideLevelFromContext(origin Level, ctx context.Context) Level

func ParseLevel

func ParseLevel(level string) (Level, error)

type Logger

type Logger logger.Logger

type ObservableFactory

type ObservableFactory interface {
	Factory
	observable.Observable[Entry]
}

func NewDefaultFactory

func NewDefaultFactory(
	ctx context.Context,
	formatter Formatter,
	writer io.Writer,
	filePath string,
	platformWriter PlatformWriter,
	needObservable bool,
) ObservableFactory

func NewNOPFactory

func NewNOPFactory() ObservableFactory

type Options

type Options struct {
	Context        context.Context
	Options        option.LogOptions
	Observable     bool
	DefaultWriter  io.Writer
	BaseTime       time.Time
	PlatformWriter PlatformWriter
}

type PlatformWriter

type PlatformWriter interface {
	DisableColors() bool
	WriteMessage(level Level, message string)
}