log

Documentation

Overview

Package log provides a global logger for rz.

Example

This example uses command-line flags to demonstrate various outputs depending on the chosen log level.

setup()
debug := flag.Bool("debug", false, "sets log level to debug")

flag.Parse()

// Default level for this example is info, unless debug flag is present

if *debug {
	logger := log.Logger()
	defer func() {
		log.SetLogger(logger)
	}()
	log.SetLogger(log.With(rz.Level(rz.DebugLevel)))
}

log.Info("This message appears when log level set to Debug or Info")

Output:

{"level":"info","timestamp":1199811905,"message":"This message appears when log level set to Debug or Info"}

Index

• func Append(fields ...rz.Field)
• func Debug(message string, fields ...rz.Field)
• func Error(message string, fields ...rz.Field)
• func Fatal(message string, fields ...rz.Field)
• func Info(message string, fields ...rz.Field)
• func Log(message string, fields ...rz.Field)
• func LogWithLevel(level rz.LogLevel, message string, fields ...rz.Field)
• func Logger() rz.Logger
• func NewDict(fields ...rz.Field) *rz.Event
• func Panic(message string, fields ...rz.Field)
• func SetLogger(log rz.Logger)
• func Warn(message string, fields ...rz.Field)
• func With(options ...rz.LoggerOption) rz.Logger

Examples

• Package
• Debug
• Error
• Fatal
• Info
• Log
• Warn

Functions

func Append

func Append(fields ...rz.Field)

Append the fields to the internal logger's context. It does not create a noew copy of the logger and rely on a mutex to enable thread safety, so `Config(With(fields...))` often is preferable.

func Debug

func Debug(message string, fields ...rz.Field)

Debug starts a new message with debug level.

Example

Example of a log at a particular "level" (in this case, "debug")

setup()
log.Debug("hello world")

Output:

{"level":"debug","timestamp":1199811905,"message":"hello world"}

func Error

func Error(message string, fields ...rz.Field)

Error logs a message with error level.

Example

Example of a log at a particular "level" (in this case, "error")

setup()
log.Error("hello world")

Output:

{"level":"error","timestamp":1199811905,"message":"hello world"}

func Fatal

func Fatal(message string, fields ...rz.Field)

Fatal logs a new message with fatal level. The os.Exit(1) function is then called, which terminates the program immediately.

Example

Example of a log at a particular "level" (in this case, "fatal")

setup()
err := errors.New("A repo man spends his life getting into tense situations")
service := "myservice"

log.Fatal(fmt.Sprintf("Cannot start %s", service), rz.Err(err), rz.String("service", service))

// Outputs: {"level":"fatal","timestamp":1199811905,"error":"A repo man spends his life getting into tense situations","service":"myservice","message":"Cannot start myservice"}

func Info

func Info(message string, fields ...rz.Field)

Info logs a new message with info level.

Example

Example of a log at a particular "level" (in this case, "info")

setup()
log.Info("hello world")

Output:

{"level":"info","timestamp":1199811905,"message":"hello world"}

func Log

func Log(message string, fields ...rz.Field)

Log logs a new message with no level. Setting GlobalLevel to Disabled will still disable events produced by this method.

Example

Example of a log with no particular "level"

setup()
log.Log("hello world")

Output:

{"timestamp":1199811905,"message":"hello world"}

func LogWithLevel

func LogWithLevel(level rz.LogLevel, message string, fields ...rz.Field)

LogWithLevel logs a new message with the given level.

func Logger

func Logger() rz.Logger

Logger returns log's logger

func NewDict

func NewDict(fields ...rz.Field) *rz.Event

NewDict create a new Dict with the logger's configuration

func Panic

func Panic(message string, fields ...rz.Field)

Panic logs a new message with panic level. The panic() function is then called, which stops the ordinary flow of a goroutine.

func SetLogger

func SetLogger(log rz.Logger)

SetLogger update log's logger

func Warn

func Warn(message string, fields ...rz.Field)

Warn logs a new message with warn level.

Example

Example of a log at a particular "level" (in this case, "warn")

setup()
log.Warn("hello world")

Output:

{"level":"warning","timestamp":1199811905,"message":"hello world"}

func With

func With(options ...rz.LoggerOption) rz.Logger

With duplicates the global logger and update it's configuration.