logs

Documentation

Index

• Variables
• func AddLevelWriter(level Level, w Writer)
• func AddLevelsWriter(levels []Level, w Writer)
• func AddWriter(w Writer)
• func Debug(args ...any)
• func Debugf(format string, args ...any)
• func EnableLevelsStackTrace(levels []Level)
• func Error(args ...any)
• func Errorf(format string, args ...any)
• func Fatal(args ...any)
• func Fatalf(format string, args ...any)
• func Info(args ...any)
• func Infof(format string, args ...any)
• func InitDefaultLogger(defaultWriter Writer)
• func LogItem(item *Item)
• func Mute(level Level, state bool)
• func ResetLevelWriters(level Level, defaultW Writer)
• func ResetLevelsWriters(levels []Level, defaultW Writer)
• func ResetWriters(defaultW Writer)
• func SetInitItemFunc(f InitItemF)
• func SetPayload(name string, value any)
• func StartDefaultLogger()
• func StartPanicWatcher()
• func StopDefaultLogger()
• func Warning(args ...any)
• func Warningf(format string, args ...any)
• type InitItemF
• type Item
  • func NewErrorItem(err error) *Item
  • func NewErrorItemf(format string, a ...any) *Item
  • func NewItem(level Level, args ...any) *Item
  • func NewItemf(level Level, format string, args ...any) *Item
  • func (i *Item) GenerateStackTrace(callsToSkip int)
  • func (i *Item) SetPayload(key string, value any)
  • func (i Item) ToString(timestamp, stacktrace bool) string
• type Level
• type Logger
  • func NewLogger(prefix string) *Logger
  • func (l *Logger) Debug(args ...any)
  • func (l *Logger) Debugf(format string, args ...any)
  • func (l *Logger) Error(args ...any)
  • func (l *Logger) Errorf(format string, args ...any)
  • func (l *Logger) Fatal(args ...any)
  • func (l *Logger) Fatalf(format string, args ...any)
  • func (l *Logger) Info(args ...any)
  • func (l *Logger) Infof(format string, args ...any)
  • func (l *Logger) LogItem(item *Item)
  • func (l *Logger) NewErrorItem(err error) *Item
  • func (l *Logger) NewErrorItemf(format string, a ...any) *Item
  • func (l *Logger) NewItem(level Level, args ...any) *Item
  • func (l *Logger) NewItemf(level Level, format string, args ...any) *Item
  • func (l *Logger) SetInitItemFunc(f InitItemF)
  • func (l *Logger) SetPayload(key string, value any)
  • func (l *Logger) Warning(args ...any)
  • func (l *Logger) Warningf(format string, args ...any)
• type Writer

Variables

var CriticalLevels = []Level{FatalLevel, ErrorLevel, WarningLevel}

CriticalLevels lists critical levels.

var FatalExitCode = 1

Exit Code generato da Fatal() e Fatalf().

var Levels = [LevelsCount]Level{
	FatalLevel,
	ErrorLevel,
	WarningLevel,
	InfoLevel,
	DebugLevel,
}

Levels is a constant of all logging levels.

var LevelsIcons = [LevelsCount]string{
	"\xE2\x9D\x8C", "\xE2\x9D\x97", "\xE2\x9A\xA0", "\xE2\x84\xB9", "\xF0\x9F\x90\x9B",
}

LevelsIcons is a constant of all logging levels UTF8 icons.

var LevelsString = [LevelsCount]string{
	"fatal", "error", "warning", "info", "debug",
}

LevelsString is a constant of all logging levels names.

Functions

func AddLevelWriter

func AddLevelWriter(level Level, w Writer)

Associa un writer a uno specifico livello. NON thread safe.

func AddLevelsWriter

func AddLevelsWriter(levels []Level, w Writer)

Associa un writer a un set di livelli. NON thread safe.

func AddWriter

func AddWriter(w Writer)

Associa un writer a tutti i livelli. NON thread safe.

func Debug

func Debug(args ...any)

Logga a livello debug.

func Debugf

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

Logga a livello debug.

func EnableLevelsStackTrace

func EnableLevelsStackTrace(levels []Level)

Attiva lo stacktrace per specifici livelli. NON thread safe.

func Error

func Error(args ...any)

Logga a livello errore.

func Errorf

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

Logga a livello errore.

func Fatal

func Fatal(args ...any)

Logga a livello fatale effetuando anche os.Exit(FatalExitCode)

func Fatalf

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

Logga a livello fatale effetuando anche os.Exit(FatalExitCode)

func Info

func Info(args ...any)

Logga a livello info.

func Infof

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

Logga a livello info.

func InitDefaultLogger

func InitDefaultLogger(defaultWriter Writer)

Invocata da sparalog.init() Inizializza la libreria allocando il logger di default e associando un writer di default (di tipo Stdout).

func LogItem

func LogItem(item *Item)

Logga un item precedentemente generato.

func Mute

func Mute(level Level, state bool)

Mute mute/unmute a specific level.

func ResetLevelWriters

func ResetLevelWriters(level Level, defaultW Writer)

Disassocia tutti i writer per un certo livello e ne reimposta un writer di default (il writer di default riceve le eventuali loggate di errore o di feedback da parte degli altri writer). NON thread safe.

func ResetLevelsWriters

func ResetLevelsWriters(levels []Level, defaultW Writer)

Disassocia tutti i writer per un set di livelli e ne reimposta un writer di default (il writer di default riceve le eventuali loggate di errore o di feedback da parte degli altri writer). NON thread safe.

func ResetWriters

func ResetWriters(defaultW Writer)

Disassocia tutti i writer e reimposta un writer di default (il writer di default riceve le eventuali loggate di errore o di feedback da parte degli altri writer). NON thread safe.

func SetInitItemFunc

func SetInitItemFunc(f InitItemF)

Imposta una funzione di inizializzazione per ogni item allocato dal logger di default.

func SetPayload

func SetPayload(name string, value any)

Setta un valore del payload di default del logger di default.

func StartDefaultLogger

func StartDefaultLogger()

Invocata da sparalog.Start() Avvia il logger di default.

func StartPanicWatcher

func StartPanicWatcher()

StartPanicWatcher starts a supervisor that monitors panics in all goroutines. Since the supervision is made starting a parent + child processes: - Call the function after all writers initialization, or at least after fatal level initialization; - This function should not to be called in debugging sessions.

func StopDefaultLogger

func StopDefaultLogger()

Invocata da sparalog.Stop() Gestisce i panic (della routine corrente), termina il dispatcher attendendo gentilmente il termine dei writer asincroni. Va chiamata al termine del main.

func Warning

func Warning(args ...any)

Logga a livello warning.

func Warningf

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

Logga a livello warning.

Types

type InitItemF

type InitItemF func(*Item)

Funzione di inizializzazione item appena dopo la sua allocazione, permette di settare ulteriormente in modo custom specifiche proprietà.

type Item

type Item struct {
	Ts        time.Time
	Timestamp string // renderizzata

	Level Level

	Prefix, Message string

	StackTrace string

	Payload map[string]any
}

func NewErrorItem

func NewErrorItem(err error) *Item

Genera un nuovo item dal logger di default, di livello errore. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func NewErrorItemf

func NewErrorItemf(format string, a ...any) *Item

Genera un nuovo item dal logger di default, di livello errore. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func NewItem

func NewItem(level Level, args ...any) *Item

Genera un nuovo item dal logger di default, di livello specifico. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func NewItemf

func NewItemf(level Level, format string, args ...any) *Item

Genera un nuovo item dal logger di default, di livello specifico. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func (*Item) GenerateStackTrace

func (i *Item) GenerateStackTrace(callsToSkip int)

GenerateStackTrace assign the stack trace of current position to the item.

func (*Item) SetPayload

func (i *Item) SetPayload(key string, value any)

Setta un valore del payload.

func (Item) ToString

func (i Item) ToString(timestamp, stacktrace bool) string

Formatta l'item sottoforma di stringa.

type Level

type Level int

Level type.

const (
	// FatalLevel - Shutdown of the service or application to prevent data loss (or further data loss).
	// Wake up the SysAdmin!
	// Stack trace enabled by default.
	FatalLevel Level = iota
	// ErrorLevel - Any error which is fatal to the operation, but not the service or application
	// (can't open a required file, missing data, incorrect connection strings, missing services, etc.).
	// SysAdmin should be notified automatically, but doesn't need to be dragged out of bed.
	// Stack trace enabled by default.
	ErrorLevel
	// WarningLevel - Anything that can potentially cause application oddities, but automatically recovered.
	WarningLevel
	// InfoLevel - General operational entries about what's going on inside the service or application.
	// Should be the out-of-the-box level.
	InfoLevel
	// DebugLevel - Tracciatura del flusso interno, di solito abilitato solo in modalità debug.
	// Mutato di default.
	DebugLevel

	LevelsCount
)

Logging levels.

type Logger

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

func NewLogger

func NewLogger(prefix string) *Logger

Alloca un nuovo logger dotato di prefisso e di differente payload, utilizzabile come componente in una struct o in un package. Eredita una copia del payload dal logger di default. - prefix: prefisso di default che comparirà nelle relative loggate.

func (*Logger) Debug

func (l *Logger) Debug(args ...any)

Logga a livello debug.

func (*Logger) Debugf

func (l *Logger) Debugf(format string, args ...any)

Logga a livello debug.

func (*Logger) Error

func (l *Logger) Error(args ...any)

Logga a livello errore.

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...any)

Logga a livello errore.

func (*Logger) Fatal

func (l *Logger) Fatal(args ...any)

Logga a livello fatale effetuando anche os.Exit(FatalExitCode)

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, args ...any)

Logga a livello fatale effetuando anche os.Exit(FatalExitCode)

func (*Logger) Info

func (l *Logger) Info(args ...any)

Logga a livello info.

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...any)

Logga a livello info.

func (*Logger) LogItem

func (l *Logger) LogItem(item *Item)

Logga un item precedentemente generato.

func (*Logger) NewErrorItem

func (l *Logger) NewErrorItem(err error) *Item

Genera un nuovo item di livello errore. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func (*Logger) NewErrorItemf

func (l *Logger) NewErrorItemf(format string, a ...any) *Item

Genera un nuovo item di livello errore. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func (*Logger) NewItem

func (l *Logger) NewItem(level Level, args ...any) *Item

Genera un nuovo item di livello specifico. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func (*Logger) NewItemf

func (l *Logger) NewItemf(level Level, format string, args ...any) *Item

Genera un nuovo item di livello specifico. Eredita una copia del payload dal logger che può essere ulteriormente customizzata.

func (*Logger) SetInitItemFunc

func (l *Logger) SetInitItemFunc(f InitItemF)

Imposta una funzione di inizializzazione per ogni item allocato dal logger.

func (*Logger) SetPayload

func (l *Logger) SetPayload(key string, value any)

Setta un valore del payload di default.

func (*Logger) Warning

func (l *Logger) Warning(args ...any)

Logga a livello warning.

func (*Logger) Warningf

func (l *Logger) Warningf(format string, args ...any)

Logga a livello warning.

type Writer

type Writer interface {
	ID() string

	Write(*Item)

	Start() error
	Stop()
	SetFeedbackChan(chan *Item)
}

Interfaccia del writer usata dal logger.