Documentation
¶
Overview ¶
Package log provides a global logger for zlog.
Example ¶
This example uses command-line flags to demonstrate various outputs depending on the chosen log level.
package main
import (
"flag"
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
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
zlog.SetGlobalLevel(zlog.InfoLevel)
if *debug {
zlog.SetGlobalLevel(zlog.DebugLevel)
}
log.Debug().Msg("This message appears only when log level set to Debug")
log.Info().Msg("This message appears when log level set to Debug or Info")
if e := log.Debug(); e.Enabled() {
// Compute log output only if enabled.
value := "bar"
e.Str("foo", value).Msg("some debug message")
}
}
Output: {"level":"info","time":1199811905,"message":"This message appears when log level set to Debug or Info"}
Index ¶
- Variables
- func Ctx(ctx context.Context) *zlog.Logger
- func Debug() *zlog.Event
- func Err(err error) *zlog.Event
- func Error() *zlog.Event
- func Errorf(format string, v ...interface{})
- func Errorln(args ...interface{})
- func Fatal() *zlog.Event
- func Fatalf(format string, args ...interface{})
- func Fatalln(args ...interface{})
- func Hook(h zlog.Hook) zlog.Logger
- func Info() *zlog.Event
- func Level(level zlog.Level) zlog.Logger
- func Log() *zlog.Event
- func Output(w io.Writer) zlog.Logger
- func Panic() *zlog.Event
- func Panicf(format string, args ...interface{})
- func Panicln(args ...interface{})
- func Print(v ...interface{})
- func Printf(format string, v ...interface{})
- func Println(args ...interface{})
- func Sample(s zlog.Sampler) zlog.Logger
- func Trace() *zlog.Event
- func Warn() *zlog.Event
- func With() zlog.Context
- func WithLevel(level zlog.Level) *zlog.Event
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var Logger = zlog.New(os.Stderr).With().Timestamp().Logger()
Logger is the global logger.
Functions ¶
func Ctx ¶
Ctx returns the Logger associated with the ctx. If no logger is associated, a disabled logger is returned.
func Debug ¶
Debug starts a new message with debug level.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "debug")
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Debug().Msg("hello world")
}
Output: {"level":"debug","time":1199811905,"message":"hello world"}
func Err ¶ added in v1.30.0
Err starts a new message with error level with err as a field if not nil or with info level if err is nil.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a conditional level based on the presence of an error.
package main
import (
"errors"
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
err := errors.New("some error")
log.Err(err).Msg("hello world")
log.Err(nil).Msg("hello world")
}
Output: {"level":"error","error":"some error","time":1199811905,"message":"hello world"} {"level":"info","time":1199811905,"message":"hello world"}
func Error ¶
Error starts a new message with error level.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "error")
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Error().Msg("hello world")
}
Output: {"level":"error","time":1199811905,"message":"hello world"}
func Errorf ¶ added in v1.30.0
func Errorf(format string, v ...interface{})
Errorf sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Errorf.
func Fatal ¶
Fatal starts a new message with fatal level. The os.Exit(1) function is called by the Msg method.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "fatal")
package main
import (
"errors"
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
err := errors.New("A repo man spends his life getting into tense situations")
service := "myservice"
log.Fatal().
Err(err).
Str("service", service).
Msgf("Cannot start %s", service)
// Outputs: {"level":"fatal","time":1199811905,"error":"A repo man spends his life getting into tense situations","service":"myservice","message":"Cannot start myservice"}
}
Output:
func Info ¶
Info starts a new message with info level.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "info")
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Info().Msg("hello world")
}
Output: {"level":"info","time":1199811905,"message":"hello world"}
func Log ¶
Log starts a new message with no level. Setting zlog.GlobalLevel to zlog.Disabled will still disable events produced by this method.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log with no particular "level"
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Log().Msg("hello world")
}
Output: {"time":1199811905,"message":"hello world"}
func Panic ¶
Panic starts a new message with panic level. The message is also sent to the panic function.
You must call Msg on the returned event in order to send the event.
func Print ¶ added in v1.3.0
func Print(v ...interface{})
Print sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Print.
Example ¶
Simple logging example using the Print function in the log package Note that both Print and Printf are at the debug log level by default
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Print("hello world")
}
Output: {"level":"debug","time":1199811905,"message":"hello world"}
func Printf ¶ added in v1.3.0
func Printf(format string, v ...interface{})
Printf sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Printf.
Example ¶
Simple logging example using the Printf function in the log package
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Printf("hello %s", "world")
}
Output: {"level":"debug","time":1199811905,"message":"hello world"}
func Trace ¶ added in v1.30.0
Trace starts a new message with trace level.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "trace")
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Trace().Msg("hello world")
}
Output: {"level":"trace","time":1199811905,"message":"hello world"}
func Warn ¶
Warn starts a new message with warn level.
You must call Msg on the returned event in order to send the event.
Example ¶
Example of a log at a particular "level" (in this case, "warn")
package main
import (
"os"
"time"
"git.tuxpa.in/a/zlog"
"git.tuxpa.in/a/zlog/log"
)
// setup would normally be an init() function, however, there seems
// to be something awry with the testing framework when we set the
// global Logger from an init()
func setup() {
zlog.TimeFieldFormat = ""
zlog.TimestampFunc = func() time.Time {
return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC)
}
log.Logger = zlog.New(os.Stdout).With().Timestamp().Logger()
}
func main() {
setup()
log.Warn().Msg("hello world")
}
Output: {"level":"warn","time":1199811905,"message":"hello world"}
Types ¶
This section is empty.
Source Files