logging

package

v0.0.20 Latest Latest Go to latest Published: Jul 17, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/andyrewlee/amux

Links

Open Source Insights

Documentation ¶

Overview ¶

Package logging is amux's file-based logger. Internal packages route diagnostics through it (Debug/Info/Warn/Error) instead of writing to stdout/stderr, which is reserved for the CLI entrypoints.

The minimum level defaults to INFO; set AMUX_LOG_LEVEL=debug (or info/warn/ error) to change it, which is required to surface the Debug call sites. AMUX_LOG_RETENTION_DAYS controls how many days of log files are retained.

Index ¶

func Close() error
func Debug(format string, args ...any)
func Error(format string, args ...any)
func GetLogPath() string
func Info(format string, args ...any)
func Initialize(logDir string, level Level) error
func SetEnabled(enabled bool)
func Warn(format string, args ...any)
type Level
- func ParseLevel(name string) (Level, bool)
- func (l Level) String() string
type Logger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Close ¶

func Close() error

Close closes the log file

func Debug ¶

func Debug(format string, args ...any)

Debug logs a debug message

func Error ¶

func Error(format string, args ...any)

Error logs an error message

func GetLogPath ¶

func GetLogPath() string

GetLogPath returns the current log file path

func Info ¶

func Info(format string, args ...any)

Info logs an info message

func Initialize ¶

func Initialize(logDir string, level Level) error

Initialize sets up the default logger

func SetEnabled ¶

func SetEnabled(enabled bool)

SetEnabled enables or disables logging

func Warn ¶

func Warn(format string, args ...any)

Warn logs a warning message

Types ¶

type Level ¶

type Level int

Level represents log severity

const (
	LevelDebug Level = iota
	LevelInfo
	LevelWarn
	LevelError
)

func ParseLevel ¶ added in v0.0.20

func ParseLevel(name string) (Level, bool)

ParseLevel maps a level name (debug/info/warn/error, case-insensitive and trimmed) to a Level. The bool is false for unrecognized input so callers can fall back to a default.

func (Level) String ¶

func (l Level) String() string

type Logger ¶

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

Logger provides structured logging

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL