logger

Documentation

Index

• type Fields
• type Logger
  • func NewDefaultLogger() Logger
  • func NewZapLogger() Logger
  • func NewZapLoggerWithFile(logfile string) Logger

Types

type Fields

type Fields map[string]any

type Logger

type Logger interface {
	// Set whether the logger prints in human-readable 'debug' output or
	// machine-readable JSON format.
	SetDebug(bool)

	// Set the log file to which the logger will write.
	SetLogFile(string)

	// Log a Go error.
	GoError(error, ...any)

	// Log a debug message.
	Debug(string, ...any)

	// Log an error message.
	Error(string, ...any)

	// Log a warning message.
	Warn(string, ...any)

	// Log an informational message.
	Info(string, ...any)

	// Log a fatal error condition and exit.
	Fatal(string, ...any)

	// Log a panic condition and exit.
	Panic(string, ...any)

	// Log a debug message with printf formatting.
	Debugf(string, ...any)

	// Log an error message with printf formatting.
	Errorf(string, ...any)

	// Log a warning message with printf formatting.
	Warnf(string, ...any)

	// Log an informational message with printf formatting.
	Infof(string, ...any)

	// Log a fatal message with printf formatting.
	Fatalf(string, ...any)

	// Log a panic message with printf formatting.
	Panicf(string, ...any)

	// Encapsulate user-specified metadata fields.
	WithFields(Fields) Logger
}

Logging structure.

To use,

1) Create a logger:

```go

lgr := logger.NewLogger()

```

2) Do things with it:

```go

lgr.Warn("Not enough coffee!")
lgr.Info("Water is heating up.")
// and so on.

```

If an empty string is passed to `NewLogger`, then the log facility will display messages on standard output.

func NewDefaultLogger

func NewDefaultLogger() Logger

Create a new default logger.

func NewZapLogger

func NewZapLogger() Logger

Create a new logger.

func NewZapLoggerWithFile

func NewZapLoggerWithFile(logfile string) Logger

Create a new logger with the given log file.