README
¶
GCP + Zap Logger
Simple wrapper around zap logger with a few extra niceties for GCP logging.
Example
Simple example with multiple outputs and formats.
package main
import (
"errors"
log "github.com/CalculatedSystems/gzlog"
)
func init() {
if err := log.Init(
log.WithLevel("ERROR"), // set level to only ERRORS
log.WithLogFile("/tmp/errors-only.log"), // write default output format (console) to file
log.WithLevel("INFO"), // change level to INFO for subsequent options
log.WithGCPMapping(), // change prefixs to match GCP logging style
log.WithStdOut("JSON"), // write to stdout using JSON format
); err != nil {
panic(err)
}
}
func main() {
// writes to STDOUT only
log.Info("giving you information")
// support for standard library log.Print functions
log.Println("calling Println")
// error out to both outputs
err := errors.New("unexpected EOF")
log.Errorf("error during processing: %v", err)
// writes to STDOUT and file
log.DPanic("failure!")
}
Console Output
{"level":"INFO","ts":"2023-03-09T13:18:42.879-0500","msg":"giving you information"}
{"level":"INFO","ts":"2023-03-09T13:18:42.880-0500","msg":"calling Println"}
{"level":"ERROR","ts":"2023-03-09T13:18:42.880-0500","msg":"error during processing: unexpected EOF"}
{"level":"CRITICAL","ts":"2023-03-09T13:18:42.880-0500","msg":"failure!"}
Logfile Contents
2023-03-09T13:18:42.880-0500 error error during processing: unexpected EOF
2023-03-09T13:18:42.880-0500 dpanic failure!
Notice how the logfile shows dpanic while the console output displays CRITICAL.
Documentation
¶
Index ¶
- func DPanic(args ...any)
- func DPanicf(template string, args ...any)
- func DPanicln(args ...any)
- func DPanicw(msg string, keysAndValues ...any)
- func Debug(args ...any)
- func Debugf(template string, args ...any)
- func Debugln(args ...any)
- func Debugw(msg string, keysAndValues ...any)
- func Error(args ...any)
- func Errorf(template string, args ...any)
- func Errorln(args ...any)
- func Errorw(msg string, keysAndValues ...any)
- func Fatal(args ...any)
- func Fatalf(template string, args ...any)
- func Fatalln(args ...any)
- func Fatalw(msg string, keysAndValues ...any)
- func Info(args ...any)
- func Infof(template string, args ...any)
- func Infoln(args ...any)
- func Infow(msg string, keysAndValues ...any)
- func Init(opts ...setupOpt) (err error)
- func Logger() *zap.SugaredLogger
- func Panic(args ...any)
- func Panicf(template string, args ...any)
- func Panicln(args ...any)
- func Panicw(msg string, keysAndValues ...any)
- func Print(args ...any)
- func Printf(template string, args ...any)
- func Println(args ...any)
- func Printw(msg string, keysAndValues ...any)
- func Warn(args ...any)
- func Warnf(template string, args ...any)
- func Warnln(args ...any)
- func Warnw(msg string, keysAndValues ...any)
- func WithGCPMapping() setupOpt
- func WithLevel(level string) setupOpt
- func WithLogFile(filename string) setupOpt
- func WithStdOut(encoding string) setupOpt
- func Writer() io.Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DPanic ¶
func DPanic(args ...any)
DPanic wraps the underlying configured loggers DPanic function
func DPanicln ¶
func DPanicln(args ...any)
DPanicln wraps the underlying configured loggers DPanicln function
func Debugln ¶
func Debugln(args ...any)
Debugln wraps the underlying configured loggers Debugln function
func Errorln ¶
func Errorln(args ...any)
Errorln wraps the underlying configured loggers Errorln function
func Fatalln ¶
func Fatalln(args ...any)
Fatalln wraps the underlying configured loggers Fatalln function
func Infoln ¶
func Infoln(args ...any)
Infoln wraps the underlying configured loggers Infoln function
func Init ¶
func Init(opts ...setupOpt) (err error)
Init modifies the global logger based on options provided. Errors on any issue provided by options
func Logger ¶
func Logger() *zap.SugaredLogger
func Panicln ¶
func Panicln(args ...any)
Panicln wraps the underlying configured loggers Panicln function
func Println ¶
func Println(args ...any)
Println wraps the underlying configured loggers Infoln function
func Warnln ¶
func Warnln(args ...any)
Warnln wraps the underlying configured loggers Warnln function
func WithGCPMapping ¶
func WithGCPMapping() setupOpt
func WithLogFile ¶
func WithLogFile(filename string) setupOpt
func WithStdOut ¶
func WithStdOut(encoding string) setupOpt
Types ¶
This section is empty.
Source Files
Directories