loggergo

README

loggergo

Logging library I've come up with in order unify way my apps implement logging.

Documentation

Overview

Package loggergo provides functionality for configuring and setting up different logging modes in Go applications. It includes support for OpenTelemetry format, JSON format, and plain format with different flavors. The package also supports enabling OpenTelemetry tracing for the logs.

Index

• func LoggerInit(ctx context.Context, config Config, additionalAttrs ...any) (*slog.Logger, error)
• type Config
• type OutputType
  • func (o OutputType) String() string

Functions

func LoggerInit

func LoggerInit(ctx context.Context, config Config, additionalAttrs ...any) (*slog.Logger, error)

The LoggerInit function initializes a logger with the provided configuration and additional attributes.

Types

type Config

type Config struct {
	Level              string     `json:"level"`             // Level specifies the log level. Valid values are "debug", "info", "warn", and "error".
	Format             string     `json:"format"`            // Format specifies the log format. Valid values are "plain" (default), "otel" and "json".
	DevMode            bool       `json:"dev_mode"`          // Dev indicates whether the logger is running in development mode.
	DevFlavor          string     `json:"dev_flavor"`        // DevFlavor specifies the development flavor. Valid values are "tint" (default), slogor and "devslog".
	OutputStream       *os.File   `json:"output_stream"`     // OutputStream specifies the output stream for the logger. Valid values are "stdout" (default) and "stderr".
	OtelTracingEnabled bool       `json:"otel_enabled"`      // OtelTracingEnabled specifies whether OpenTelemetry support is enabled. Default is true.
	OtelLoggerName     string     `json:"otel_logger_name"`  // OtelLoggerName specifies the name of the logger for OpenTelemetry.
	Output             OutputType `json:"output"`            // Output specifies where logs will be sent to. Valid values are "console", "otel" and "fanout" (default) - which is a combination of "console" and "otel".
	OtelServiceName    string     `json:"otel_service_name"` // OtelServiceName specifies the service name for OpenTelemetry.
}

Config represents the configuration options for the LoggerGo logger.

type OutputType

type OutputType int

OutputType represents the type of output for the logger.

const (
	// OutputConsole represents console output.
	OutputConsole OutputType = iota
	// OutputOtel represents otel output.
	OutputOtel
	// OutputFanout represents both console and otel output.
	OutputFanout
)

func (OutputType) String

func (o OutputType) String() string