log

Documentation

Overview

Package log exports logging primitives.

This package is based on upspin.io/log. Its license as well as the original code can be found in the upspin repository.

Index

• Variables
• func At(level string) bool
• func Fatal(v ...any)
• func Fatalf(format string, v ...any)
• func GetLevel() string
• func NewStdLogger(l Logger) *log.Logger
• func Print(v ...any)
• func Printf(format string, v ...any)
• func Println(v ...any)
• func SetLevel(level string) error
• func SetOutput(w io.Writer)
• type Level
• type Logger

Variables

var (
	Debug = &logger{DebugLevel}
	Info  = &logger{InfoLevel}
	Error = &logger{ErrorLevel}
)

The set of default loggers for each log level.

Functions

func At

func At(level string) bool

At returns whether the level will be logged currently.

func Fatal

func Fatal(v ...any)

Fatal writes a message to the log and aborts.

func Fatalf

func Fatalf(format string, v ...any)

Fatalf writes a formatted message to the log and aborts.

func GetLevel

func GetLevel() string

GetLevel returns the current logging level.

func NewStdLogger

func NewStdLogger(l Logger) *log.Logger

NewStdLogger creates a *log.Logger ("log" is from the Go standard library) that forwards messages to the provided logger using a logBridge. The standard logger is configured with log.Lshortfile, this log line format which is parsed to extract the log message (skipping the filename, line number) to forward it to the provided logger.

func Print

func Print(v ...any)

Print writes a message to the log.

func Printf

func Printf(format string, v ...any)

Printf writes a formatted message to the log.

func Println

func Println(v ...any)

Println writes a line to the log.

func SetLevel

func SetLevel(level string) error

SetLevel sets the current level of logging.

func SetOutput

func SetOutput(w io.Writer)

SetOutput sets the default loggers to write to w. If w is nil, the default loggers are disabled.

Types

type Level

type Level int

Level represents the level of logging.

const (
	DebugLevel Level = iota
	InfoLevel
	ErrorLevel
	DisabledLevel
)

Different levels of logging.

type Logger

type Logger interface {
	// Printf writes a formated message to the log.
	Printf(format string, v ...any)

	// Print writes a message to the log.
	Print(v ...any)

	// Println writes a line to the log.
	Println(v ...any)

	// Fatal writes a message to the log and aborts.
	Fatal(v ...any)

	// Fatalf writes a formated message to the log and aborts.
	Fatalf(format string, v ...any)
}

Logger is the interface for logging messages.