logger

Documentation

Overview

Package logger incapsulates logger functions

Index

• type AppLogger
  • func Create(appPath, userSetLogLevel string) (*AppLogger, error)
  • func Get() *AppLogger
  • func (l *AppLogger) Close()
  • func (l *AppLogger) Debug(format string, args ...any)
  • func (l *AppLogger) Error(format string, args ...any)
  • func (l *AppLogger) Info(format string, args ...any)
  • func (l *AppLogger) Warn(format string, args ...any)
• type LogLevel
• type Once

Types

type AppLogger

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

AppLogger is a simple logger that writes messages to a file.

func Create

func Create(appPath, userSetLogLevel string) (*AppLogger, error)

Create - creates a new logger with a specific log level. appPath - where log file will be stored. userSetLogLevel - user-defined log level (debug or info).

func Get

func Get() *AppLogger

Get - returns application state.

func (*AppLogger) Close

func (l *AppLogger) Close()

Close - closes the log file.

func (*AppLogger) Debug

func (l *AppLogger) Debug(format string, args ...any)

Debug - prints debug message if log level is set to debug.

func (*AppLogger) Error

func (l *AppLogger) Error(format string, args ...any)

Error - prints an error message regardless of the log level.

func (*AppLogger) Info

func (l *AppLogger) Info(format string, args ...any)

Info - prints info message if log level is set to debug or info.

func (*AppLogger) Warn

func (l *AppLogger) Warn(format string, args ...any)

Warn - prints a warning message regardless of the log level.

type LogLevel

type LogLevel int

LogLevel is a subject for revising. Probably it's better to have a boolean flag to switch on/off debug logging.

const (
	// LevelDebug - when log level is 'debug', then all messages will be printed into the log file.
	LevelDebug LogLevel = iota
	// LevelInfo - when log level is 'info', then only 'info' and more severe messages will be printed into the log file.
	LevelInfo
)

type Once

type Once interface {
	Do(func())
}

Once - this interface is used to avoid sync.Once restrictions in unit-tests.