logging

Documentation

Overview

Package logging provides logging functionalities for GoFr applications.

Index

• type Level
  • func GetLevelFromString(level string) Level
  • func GetLogLevelForError(err error) Level
  • func (l Level) MarshalJSON() ([]byte, error)
  • func (l Level) String() string
• type LogLevelResponder
• type Logger
  • func NewFileLogger(path string) Logger
  • func NewLogger(level Level) Logger
  • func NewMockLogger(level Level) Logger
• type MockLogger
  • func (m *MockLogger) ChangeLevel(level Level)
  • func (m *MockLogger) Debug(args ...any)
  • func (m *MockLogger) Debugf(format string, args ...any)
  • func (m *MockLogger) Error(args ...any)
  • func (m *MockLogger) Errorf(format string, args ...any)
  • func (m *MockLogger) Fatal(args ...any)
  • func (m *MockLogger) Fatalf(format string, args ...any)
  • func (m *MockLogger) Info(args ...any)
  • func (m *MockLogger) Infof(format string, args ...any)
  • func (m *MockLogger) Log(args ...any)
  • func (m *MockLogger) Logf(format string, args ...any)
  • func (m *MockLogger) Notice(args ...any)
  • func (m *MockLogger) Noticef(format string, args ...any)
  • func (m *MockLogger) Warn(args ...any)
  • func (m *MockLogger) Warnf(format string, args ...any)
• type PrettyPrint

Types

type Level

type Level int

Level represents different logging levels.

const (
	DEBUG Level = iota + 1
	INFO
	NOTICE
	WARN
	ERROR
	FATAL
)

func GetLevelFromString

func GetLevelFromString(level string) Level

GetLevelFromString converts a string to a logging level.

func GetLogLevelForError

func GetLogLevelForError(err error) Level

GetLogLevelForError returns the log level for the given error. If the error implements [logLevelResponder], its log level is returned. Otherwise, the default log level "error" is returned.

func (Level) MarshalJSON

func (l Level) MarshalJSON() ([]byte, error)

func (Level) String

func (l Level) String() string

String returns the string representation of the log level.

type LogLevelResponder

type LogLevelResponder interface {
	LogLevel() Level
}

LogLevelResponder is an interface that provides a method to get the log level.

type Logger

type Logger interface {
	Debug(args ...any)
	Debugf(format string, args ...any)
	Log(args ...any)
	Logf(format string, args ...any)
	Info(args ...any)
	Infof(format string, args ...any)
	Notice(args ...any)
	Noticef(format string, args ...any)
	Warn(args ...any)
	Warnf(format string, args ...any)
	Error(args ...any)
	Errorf(format string, args ...any)
	Fatal(args ...any)
	Fatalf(format string, args ...any)
	ChangeLevel(level Level)
}

Logger represents a logging interface.

func NewFileLogger

func NewFileLogger(path string) Logger

NewFileLogger creates a new logger instance with logging to a file.

func NewLogger

func NewLogger(level Level) Logger

NewLogger creates a new logger instance with the specified logging level.

func NewMockLogger

func NewMockLogger(level Level) Logger

type MockLogger

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

func (*MockLogger) ChangeLevel

func (m *MockLogger) ChangeLevel(level Level)

func (*MockLogger) Debug

func (m *MockLogger) Debug(args ...any)

func (*MockLogger) Debugf

func (m *MockLogger) Debugf(format string, args ...any)

func (*MockLogger) Error

func (m *MockLogger) Error(args ...any)

func (*MockLogger) Errorf

func (m *MockLogger) Errorf(format string, args ...any)

func (*MockLogger) Fatal

func (m *MockLogger) Fatal(args ...any)

func (*MockLogger) Fatalf

func (m *MockLogger) Fatalf(format string, args ...any)

func (*MockLogger) Info

func (m *MockLogger) Info(args ...any)

func (*MockLogger) Infof

func (m *MockLogger) Infof(format string, args ...any)

func (*MockLogger) Log

func (m *MockLogger) Log(args ...any)

func (*MockLogger) Logf

func (m *MockLogger) Logf(format string, args ...any)

func (*MockLogger) Notice

func (m *MockLogger) Notice(args ...any)

func (*MockLogger) Noticef

func (m *MockLogger) Noticef(format string, args ...any)

func (*MockLogger) Warn

func (m *MockLogger) Warn(args ...any)

func (*MockLogger) Warnf

func (m *MockLogger) Warnf(format string, args ...any)

type PrettyPrint

type PrettyPrint interface {
	PrettyPrint(writer io.Writer)
}