logger

Documentation

Index

• Constants
• Variables
• func SetCustomSocket(address, network string) (err error)
• func SetLogName(p string) (err error)
• func Stats() (logs, pending, drop, errs uint64)
• type Level
  • func (level Level) String() string
• type Logger
  • func New(level Level) (l *Logger)
  • func (l *Logger) Close()
  • func (l *Logger) Debug(prefix, format string, v ...interface{})
  • func (l *Logger) Error(prefix, format string, v ...interface{})
  • func (l *Logger) Info(prefix, format string, v ...interface{})
  • func (l *Logger) Level() Level
  • func (l *Logger) Panic(prefix, format string, v ...interface{})
  • func (l *Logger) Print(logMsg string)
  • func (l *Logger) Printf(level Level, prefix, format string, v ...interface{})
  • func (l *Logger) SetAccessLogSample(sample uint64)
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) Warn(prefix, format string, v ...interface{})

Constants

const (
	NumMessages    = 10 * 1024 // number of allowed log messages
	MaxFreeMsgSize = 8 * 1024  // maximum size of a free pooled msg
)

Variables

var (
	// offLogger is a dummy no-op logger.
	OffLogger = New(Levels.Off)

	// Levels is a singleton that represents possible log levels.
	Levels = struct {
		Off    Level
		Panic  Level
		Error  Level
		Warn   Level
		Info   Level
		Debug  Level
		Access Level
	}{
		Access: (-1),
		Off:    (0),
		Panic:  (1),
		Error:  (2),
		Warn:   (3),
		Info:   (4),
		Debug:  (5),
	}

	// CfgLevels maps strings to Level. The intent is to use this during config
	// time.
	CfgLevels = map[string]Level{
		"access": Levels.Access,
		"off":    Levels.Off,
		"panic":  Levels.Panic,
		"error":  Levels.Error,
		"warn":   Levels.Warn,
		"info":   Levels.Info,
		"debug":  Levels.Debug,
	}
)

var (
	ErrLogFullBuf           = errors.New("Log message queue is full")
	ErrFreeMessageOverflow  = errors.New("Too many free messages. Overflow of fixed	set.")
	ErrFreeMessageUnderflow = errors.New("Too few free messages. Underflow of fixed	set.")
	ErrUnavailable          = errors.New("Log system is shut down.")
)

Functions

func SetCustomSocket

func SetCustomSocket(address, network string) (err error)

When called, this will switch over to writting log messages to the defined socket.

func SetLogName

func SetLogName(p string) (err error)

SetLogName sets the indentifier used by syslog for this program

func Stats

func Stats() (logs, pending, drop, errs uint64)

Stats returns the current status of the logger. It reports: * logs: number of logs attempted to be written since startup * pending: number of logs queued to be written * drop: numer of logs that have been dropped, because the write queue is full, since startup * errs: number of errors seen while trying to write logs since startup

Types

type Level

type Level int

func (Level) String

func (level Level) String() string

type Logger

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

func New

func New(level Level) (l *Logger)

func (*Logger) Close

func (l *Logger) Close()

func (*Logger) Debug

func (l *Logger) Debug(prefix, format string, v ...interface{})

func (*Logger) Error

func (l *Logger) Error(prefix, format string, v ...interface{})

func (*Logger) Info

func (l *Logger) Info(prefix, format string, v ...interface{})

func (*Logger) Level

func (l *Logger) Level() Level

func (*Logger) Panic

func (l *Logger) Panic(prefix, format string, v ...interface{})

func (*Logger) Print

func (l *Logger) Print(logMsg string)

func (*Logger) Printf

func (l *Logger) Printf(level Level, prefix, format string, v ...interface{})

func (*Logger) SetAccessLogSample

func (l *Logger) SetAccessLogSample(sample uint64)

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

func (*Logger) Warn

func (l *Logger) Warn(prefix, format string, v ...interface{})