corelog

README

Corelog

Logging library used across Source Network projects.

Usage

package main

import "github.com/sourcenetwork/corelog"

var log = corelog.NewLogger("main")

func main() {
    // with attributes
    log.Info("message", corelog.String("key", "val"))

    // with context
    log.InfoContext(ctx, "message", corelog.Int("key", 10))

    // with error stacktrace
    log.ErrorE("message", err, corelog.Bool("key", true))

    // with common attributes
    attrs := log.WithAttrs(corelog.Float64("key", float64(1.234)))
    attrs.Info("message")

    // with common group
    group := log.WithGroup("group")
    group.Info("message", corelog.Any("key", struct{}{}))
}

Configuration

Default config values can be set via environment variables.

Env	Description	Values
LOG_LEVEL	sets logging level	info error
LOG_FORMAT	sets logging format	json text
LOG_STACKTRACE	enables stacktraces	true false
LOG_SOURCE	enables source location	true false
LOG_OUTPUT	sets the output path	stderr stdout
LOG_OVERRIDES	logger specific overrides	net,level=info;core,output=stdout
LOG_NO_COLOR	disable color text output	true false

Documentation

Index

• Constants
• func Any(key string, value any) slog.Attr
• func Bool(key string, value bool) slog.Attr
• func Duration(key string, value time.Duration) slog.Attr
• func Float64(key string, value float64) slog.Attr
• func Group(key string, args ...any) slog.Attr
• func Int(key string, value int) slog.Attr
• func Int64(key string, value int64) slog.Attr
• func SetConfig(cfg Config)
• func SetConfigOverride(name string, cfg Config)
• func SetConfigOverrides(text string)
• func String(key string, value string) slog.Attr
• func Time(key string, value time.Time) slog.Attr
• func Uint64(key string, value uint64) slog.Attr
• type Config
  • func DefaultConfig() Config
  • func GetConfig(name string) Config
• type Logger
  • func NewLogger(name string) *Logger
  • func (l *Logger) Error(msg string, args ...slog.Attr)
  • func (l *Logger) ErrorContext(ctx context.Context, msg string, args ...slog.Attr)
  • func (l *Logger) ErrorContextE(ctx context.Context, msg string, err error, args ...slog.Attr)
  • func (l *Logger) ErrorE(msg string, err error, args ...slog.Attr)
  • func (l *Logger) Info(msg string, args ...slog.Attr)
  • func (l *Logger) InfoContext(ctx context.Context, msg string, args ...slog.Attr)
  • func (l *Logger) WithAttrs(attrs ...slog.Attr) *Logger
  • func (l *Logger) WithGroup(name string) *Logger

Constants

const (
	// LevelDebug specifies info log level.
	LevelInfo = "info"
	// LevelDebug specifies error log level.
	LevelError = "error"
	// FormatText specifies text output for a logger.
	FormatText = "text"
	// FormatJSON specifies json output for a logger.
	FormatJSON = "json"
	// OutputStdout specifies stdout output for a logger.
	OutputStdout = "stdout"
	// OutputStderr specifies stderr output for a logger.
	OutputStderr = "stderr"
)

Functions

func Any

func Any(key string, value any) slog.Attr

Any returns an slog.Attr for the supplied value.

func Bool

func Bool(key string, value bool) slog.Attr

Bool returns an slog.Attr for a bool.

func Duration

func Duration(key string, value time.Duration) slog.Attr

Duration returns an slog.Attr for a time.Duration.

func Float64

func Float64(key string, value float64) slog.Attr

Float64 returns an slog.Attr for a floating-point number.

func Group

func Group(key string, args ...any) slog.Attr

Group returns an slog.Attr for a Group Value.

func Int

func Int(key string, value int) slog.Attr

Int converts an int to an int64 and returns an slog.Attr with that value.

func Int64

func Int64(key string, value int64) slog.Attr

Int64 returns an slog.Attr for an int64.

func SetConfig

func SetConfig(cfg Config)

SetConfig sets the config values for all loggers.

func SetConfigOverride

func SetConfigOverride(name string, cfg Config)

SetConfigOverride sets the config override for the given named logger.

func SetConfigOverrides

func SetConfigOverrides(text string)

SetConfigOverrides parses and sets config overrides from the given text.

Overrides are separated by ";", and override values are comma separated, where the first value is the name, and the remaining values are key value pairs separated by "=".

func String

func String(key string, value string) slog.Attr

String returns an slog.Attr for a string value.

func Time

func Time(key string, value time.Time) slog.Attr

Time returns an slog.Attr for a time.Time.

func Uint64

func Uint64(key string, value uint64) slog.Attr

Uint64 returns an slog.Attr for a uint64.

Types

type Config

type Config struct {
	// Level specifies the logging level.
	Level string
	// Format specifies the output format of the logger.
	Format string
	// EnableStackTrace enables logging error stack traces.
	EnableStackTrace bool
	// EnableSource enables logging the source location.
	EnableSource bool
	// Output specifies the output path for the logger.
	Output string
	// DisableColor specifies if colored output is disabled.
	DisableColor bool
}

Config contains general settings for a logger.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns a config with default values.

The default values are derived from environment variables.

func GetConfig

func GetConfig(name string) Config

GetConfig returns the config for a named logger.

type Logger

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

Logger is a logger that wraps the slog package.

func NewLogger

func NewLogger(name string) *Logger

NewLogger returns a new named logger.

func (*Logger) Error

func (l *Logger) Error(msg string, args ...slog.Attr)

Error logs a message at error log level.

func (*Logger) ErrorContext

func (l *Logger) ErrorContext(ctx context.Context, msg string, args ...slog.Attr)

ErrorContext logs a message at error log level.

func (*Logger) ErrorContextE

func (l *Logger) ErrorContextE(ctx context.Context, msg string, err error, args ...slog.Attr)

ErrorContextE logs a message at error log level with an error stacktrace.

func (*Logger) ErrorE

func (l *Logger) ErrorE(msg string, err error, args ...slog.Attr)

ErrorE logs a message at error log level with an error stacktrace.

func (*Logger) Info

func (l *Logger) Info(msg string, args ...slog.Attr)

Info logs a message at info log level.

func (*Logger) InfoContext

func (l *Logger) InfoContext(ctx context.Context, msg string, args ...slog.Attr)

InfoContext logs a message at info log level.

func (*Logger) WithAttrs

func (l *Logger) WithAttrs(attrs ...slog.Attr) *Logger

WithAttrs returns a new Logger whose attributes consist of both the receiver's attributes and the arguments.

func (*Logger) WithGroup

func (l *Logger) WithGroup(name string) *Logger

WithGroup returns a new Logger with the given group appended to the receiver's existing groups.