fastlog

Documentation

Overview

Package fastlog configures structured slog handlers.

Environment defaults emit JSON events to stderr. The package registers stdout and stderr stream handlers by default:

import "github.com/InsideGallery/core/fastlog"

New code should prefer NewLoggerWithRegistry, SetupDefaultLogger, and InstallDefaultLogger so handler registries and process-wide defaults have explicit ownership.

Compatibility: NewLogger and SetupDefaultLog remain available for existing package-level wiring. File logging is available only when consumers import fastlog/handlers/logfile for legacy compatibility.

Index

• Constants
• func NewLogger(cfg *Config, m ...slogmulti.Middleware) (*slog.Logger, error)
• func NewLoggerWithRegistry(cfg *Config, registry *handlers.Registry, m ...slogmulti.Middleware) (*slog.Logger, error)
• func SetupDefault(ctx context.Context, cfg *Config, m ...slogmulti.Middleware) (func() error, error)
• func SetupDefaultLog(m ...slogmulti.Middleware)
• type Config
  • func GetConfigFromEnv() (*Config, error)
  • func (c *Config) GetHandler(m ...slogmulti.Middleware) (slog.Handler, error)
  • func (c *Config) GetHandlerFromRegistry(registry *handlers.Registry, m ...slogmulti.Middleware) (slog.Handler, error)
• type DefaultLoggerHandle
  • func InstallDefaultLogger(logger *slog.Logger) *DefaultLoggerHandle
  • func SetupDefaultLogger(cfg *Config, m ...slogmulti.Middleware) (*DefaultLoggerHandle, error)
  • func (h *DefaultLoggerHandle) Close() error

Constants

const EnvPrefix = "LOG"

const (
	Separator = ":"
)

Functions

func NewLogger

func NewLogger(cfg *Config, m ...slogmulti.Middleware) (*slog.Logger, error)

NewLogger creates a logger from explicit config and the compatibility handler registry.

Deprecated: use SetupDefault for standard bootstrapping or NewLoggerWithRegistry when callers need bespoke wiring.

func NewLoggerWithRegistry

func NewLoggerWithRegistry(
	cfg *Config,
	registry *handlers.Registry,
	m ...slogmulti.Middleware,
) (*slog.Logger, error)

NewLoggerWithRegistry creates a logger from explicit config and handler registry.

func SetupDefault

func SetupDefault(
	ctx context.Context,
	cfg *Config,
	m ...slogmulti.Middleware,
) (func() error, error)

SetupDefault creates and installs a process-wide logger from explicit config.

func SetupDefaultLog

func SetupDefaultLog(m ...slogmulti.Middleware)

SetupDefaultLog reads logger config from environment and installs it as slog default.

Deprecated: use GetConfigFromEnv plus SetupDefault so callers can handle errors and close the logger.

Types

type Config

type Config struct {
	Outputs         []string   `env:"_OUTPUTS" envDefault:"stderr:json"`
	Level           slog.Level `env:"_LEVEL" envDefault:"INFO"`
	Caller          bool       `env:"_CALLER" envDefault:"true"`
	ErrorFormatting bool       `env:"_ERROR_FORMATING" envDefault:"false"`
}

func GetConfigFromEnv

func GetConfigFromEnv() (*Config, error)

func (*Config) GetHandler

func (c *Config) GetHandler(m ...slogmulti.Middleware) (slog.Handler, error)

GetHandler returns a slog handler from the package-level compatibility registry.

Deprecated: use GetHandlerFromRegistry with an explicit handler registry.

func (*Config) GetHandlerFromRegistry

func (c *Config) GetHandlerFromRegistry(registry *handlers.Registry, m ...slogmulti.Middleware) (slog.Handler, error)

GetHandlerFromRegistry returns a slog handler from an explicit handler registry.

type DefaultLoggerHandle

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

DefaultLoggerHandle restores a previous slog default logger.

func InstallDefaultLogger

func InstallDefaultLogger(logger *slog.Logger) *DefaultLoggerHandle

InstallDefaultLogger installs a process-wide slog default with a restore path.

Use InstallDefaultLogger when callers need bespoke logger wiring. SetupDefault is the standard bootstrap.

func SetupDefaultLogger

func SetupDefaultLogger(cfg *Config, m ...slogmulti.Middleware) (*DefaultLoggerHandle, error)

SetupDefaultLogger creates and installs a process-wide logger from explicit config.

func (*DefaultLoggerHandle) Close

func (h *DefaultLoggerHandle) Close() error

Close restores the previous process-wide slog default and flushes the installed handler.