go_logger

README

go-logger

Simple logger used mostly in Randlabs.IO apps

Documentation

Index

• Constants
• type ErrorHandler
• type FileOptions
• type LogLevel
• type Logger
  • func Create(options Options) (*Logger, error)
  • func Default() *Logger
  • func (logger *Logger) Debug(level uint, obj interface{})
  • func (logger *Logger) Destroy()
  • func (logger *Logger) Error(obj interface{})
  • func (logger *Logger) Info(obj interface{})
  • func (logger *Logger) SetDebugLevel(newLevel uint)
  • func (logger *Logger) SetLevel(newLevel LogLevel)
  • func (logger *Logger) Warning(obj interface{})
• type Options
• type SyslogOptions

Constants

const (
	LogLevelQuiet   LogLevel = 0
	LogLevelError            = 1
	LogLevelWarning          = 2
	LogLevelInfo             = 3
	LogLevelDebug            = 4
)

Types

type ErrorHandler

type ErrorHandler func(message string)

ErrorHandler is a callback to call if an internal error must be notified.

type FileOptions

type FileOptions file.Options

FileOptions specifies the file logger settings.

type LogLevel

type LogLevel uint

LogLevel defines the level of message verbosity.

type Logger

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

Logger is the object that controls logging.

func Create

func Create(options Options) (*Logger, error)

Create creates a new logger.

func Default

func Default() *Logger

Default returns a logger that only outputs error and warnings to the console.

func (*Logger) Debug

func (logger *Logger) Debug(level uint, obj interface{})

Debug emits a debug message into the configured targets. If a string is passed, output format will be in DATE [LEVEL] MESSAGE. If a struct is passed, output will be in json with level and timestamp fields automatically added.

func (*Logger) Destroy

func (logger *Logger) Destroy()

Destroy shuts down the logger.

func (*Logger) Error

func (logger *Logger) Error(obj interface{})

Error emits an error message into the configured targets. If a string is passed, output format will be in DATE [LEVEL] MESSAGE. If a struct is passed, output will be in json with level and timestamp fields automatically added.

func (*Logger) Info

func (logger *Logger) Info(obj interface{})

Info emits an information message into the configured targets. If a string is passed, output format will be in DATE [LEVEL] MESSAGE. If a struct is passed, output will be in json with level and timestamp fields automatically added.

func (*Logger) SetDebugLevel

func (logger *Logger) SetDebugLevel(newLevel uint)

SetDebugLevel sets the minimum level for debug messages.

func (*Logger) SetLevel

func (logger *Logger) SetLevel(newLevel LogLevel)

SetLevel sets the minimum level for all messages.

func (*Logger) Warning

func (logger *Logger) Warning(obj interface{})

Warning emits a warning message into the configured targets. If a string is passed, output format will be in DATE [LEVEL] MESSAGE. If a struct is passed, output will be in json with level and timestamp fields automatically added.

type Options

type Options struct {
	// Disable console output.
	DisableConsole bool `json:"disableConsole,omitempty"`

	// Optionally enable file logging and establish its settings.
	FileLog *FileOptions `json:"fileLog,omitempty"`

	// Optionally enable syslog logging and establish its settings.
	SysLog *SyslogOptions `json:"sysLog,omitempty"`

	// Set the initial logging level to use.
	Level LogLevel `json:"level,omitempty"`

	// Set the initial logging level for debug output to use.
	DebugLevel uint `json:"debugLevel,omitempty"`

	// Use the local computer time instead of UTC.
	UseLocalTime bool `json:"useLocalTime,omitempty"`

	// A callback to call if an internal error is encountered.
	ErrorHandler ErrorHandler
}

Options specifies the logger settings to use when initialized.

type SyslogOptions

type SyslogOptions syslog.Options

SyslogOptions specifies the syslog logger settings.