logger

README

logger

logger AFAIRE

Documentation

Overview

Package logger AFAIRE

Index

• func GetFacilityFromString(facility string) syslog.Priority
• type Encoder
• type FileOutput
  • func NewFileOutput(name string) (*FileOutput, error)
  • func (o *FileOutput) Close() error
• type Level
  • func GetLevelFromString(level string) Level
• type Logger
  • func New(runner string, level Level, output Output, encoder Encoder) *Logger
  • func (l *Logger) Clone() *Logger
  • func (l *Logger) CloneWContext() *Logger
  • func (l *Logger) Debug(msg string, args ...interface{})
  • func (l *Logger) Error(msg string, args ...interface{})
  • func (l *Logger) Fatal(msg string, args ...interface{})
  • func (l *Logger) Info(msg string, args ...interface{})
  • func (l *Logger) Log(level Level, msg string, args ...interface{})
  • func (l *Logger) Notice(msg string, args ...interface{})
  • func (l *Logger) Set(key string, value interface{}) *Logger
  • func (l *Logger) Setf(key string, format string, args ...interface{}) *Logger
  • func (l *Logger) Trace(msg string, args ...interface{})
  • func (l *Logger) Warning(msg string, args ...interface{})
• type Output
• type OutputProperties
  • func NewOutputProperties(fDateTime bool, fLevel bool, fNewLine bool) *OutputProperties
  • func (op *OutputProperties) AddNewLine() bool
  • func (op *OutputProperties) LogDateTime() bool
  • func (op *OutputProperties) LogLevel() bool
• type StdEncoder
  • func NewStdEncoder() *StdEncoder
  • func (e *StdEncoder) Encode(r string, l Level, m string, c context, dt time.Time, o Output) ([]byte, error)
• type SyslogOutput
  • func NewSyslogOutput(facility string) (*SyslogOutput, error)
  • func (o *SyslogOutput) Log(level Level, buf []byte) error
• type WriterOutput
  • func NewWriterOutput(iow io.Writer, op *OutputProperties) *WriterOutput
  • func (o *WriterOutput) Log(level Level, buf []byte) error

Functions

func GetFacilityFromString

func GetFacilityFromString(facility string) syslog.Priority

GetFacilityFromString TODO

Types

type Encoder

type Encoder interface {
	// AFAIRE
	Encode(string, Level, string, context, time.Time, Output) ([]byte, error)
}

Encoder représente l'interface qui doit être implémentée par tous les encodeurs.

type FileOutput

type FileOutput struct {
	*WriterOutput
	// contains filtered or unexported fields
}

FileOutput AFAIRE

func NewFileOutput

func NewFileOutput(name string) (*FileOutput, error)

NewFileOutput AFAIRE

func (*FileOutput) Close

func (o *FileOutput) Close() error

Close AFAIRE

type Level

type Level uint32

Level représente un niveau de log.

const (
	// Trace
	TLevel Level = iota
	// Debug
	DLevel
	// Info
	ILevel
	// Notice
	NLevel
	// Warning
	WLevel
	// Error
	ELevel
	// Fatal
	FLevel
)

Les différents niveaux de log utilisables.

func GetLevelFromString

func GetLevelFromString(level string) Level

GetLevelFromString retourne le niveau de log correspondant à la chaîne de caractères passée en paramètre. Si celle-ci n'est pas valide, le niveau de log "TLevel" est utilisé par defaut.

type Logger

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

Logger représente un logger.

func New

func New(runner string, level Level, output Output, encoder Encoder) *Logger

New permet de créer un nouveau "Logger".

func (*Logger) Clone

func (l *Logger) Clone() *Logger

Clone AFAIRE.

func (*Logger) CloneWContext

func (l *Logger) CloneWContext() *Logger

CloneWContext AFAIRE.

func (*Logger) Debug

func (l *Logger) Debug(msg string, args ...interface{})

Debug AFAIRE

func (*Logger) Error

func (l *Logger) Error(msg string, args ...interface{})

Error AFAIRE

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, args ...interface{})

Fatal AFAIRE

func (*Logger) Info

func (l *Logger) Info(msg string, args ...interface{})

Info AFAIRE

func (*Logger) Log

func (l *Logger) Log(level Level, msg string, args ...interface{})

Log AFAIRE

func (*Logger) Notice

func (l *Logger) Notice(msg string, args ...interface{})

Notice AFAIRE

func (*Logger) Set

func (l *Logger) Set(key string, value interface{}) *Logger

Set permet d'ajouter un couple clé/valeur au contexte.

func (*Logger) Setf

func (l *Logger) Setf(key string, format string, args ...interface{}) *Logger

Setf permet d'ajouter un couple clé/valeur au contexte. La valeur est créée via l'utilisation d'une chaine de formatage et d'arguments.

func (*Logger) Trace

func (l *Logger) Trace(msg string, args ...interface{})

Trace AFAIRE

func (*Logger) Warning

func (l *Logger) Warning(msg string, args ...interface{})

Warning AFAIRE

type Output

type Output interface {
	// Est-ce que la date et l'heure doivent être écrites ?
	LogDateTime() bool
	// Est-ce que le niveau de log doit être écrit ?
	LogLevel() bool
	// Est-ce qu'un "\n" doit être ajouté à la fin du message ?
	AddNewLine() bool
	// Cette fonction écrit les données du buffer résultant de l'encodage.
	Log(level Level, buf []byte) error
	// Cette fonction, si nécessaire, ferme la sortie.
	Close() error
}

Output décrit l'interface qui doit être implémentée par toutes les sorties.

var Stderr Output = newStderrOutput()

Stderr correspond à la sortie standard "stderr".

var Stdout Output = newStdoutOutput()

Stdout correspond à la sortie standard "stdout".

type OutputProperties

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

OutputProperties permet de définir les propriétés d'une sortie.

func NewOutputProperties

func NewOutputProperties(fDateTime bool, fLevel bool, fNewLine bool) *OutputProperties

NewOutputProperties permet de créer une instance du type "OutputProperties".

func (*OutputProperties) AddNewLine

func (op *OutputProperties) AddNewLine() bool

AddNewLine permet d'indiquer à l'encodeur si il doit ajouté un "\n" à la fin du message.

func (*OutputProperties) LogDateTime

func (op *OutputProperties) LogDateTime() bool

LogDateTime permet d'indiquer à l'encodeur si il doit encodé la date et l'heure.

func (*OutputProperties) LogLevel

func (op *OutputProperties) LogLevel() bool

LogLevel permet d'indiquer à l'encodeur si il doit encodé le niveau de log.

type StdEncoder

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

StdEncoder représente l'encodeur standard. Il encode au format "logfmt" le contexte du message.

func NewStdEncoder

func NewStdEncoder() *StdEncoder

NewStdEncoder permet de créer une nouvelle instance d'un encodeur de type "StdEncoder".

func (*StdEncoder) Encode

func (e *StdEncoder) Encode(r string, l Level, m string, c context, dt time.Time, o Output) ([]byte, error)

Encode encode le message de log.

type SyslogOutput

type SyslogOutput struct {
	*syslog.Writer
	*OutputProperties
}

SyslogOutput AFAIRE

func NewSyslogOutput

func NewSyslogOutput(facility string) (*SyslogOutput, error)

NewSyslogOutput AFAIRE

func (*SyslogOutput) Log

func (o *SyslogOutput) Log(level Level, buf []byte) error

Log AFAIRE

type WriterOutput

type WriterOutput struct {
	io.Writer
	*OutputProperties
}

WriterOutput permet de définir des sorties basées sur un "Writer".

func NewWriterOutput

func NewWriterOutput(iow io.Writer, op *OutputProperties) *WriterOutput

NewWriterOutput permet de créer une instance du type "WriterOutput".

func (*WriterOutput) Log

func (o *WriterOutput) Log(level Level, buf []byte) error

Log écrit les données du buffer résultant de l'encodage.