zaplg

package
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package zaplg adapts Uber's zap logging library for use with the lg interface.

Index

Constants

This section is empty.

Variables

View Source
var TestingFactoryFn = func(w io.Writer) lg.Log {

	return NewWith(w, testingFormat, true, true, true, true, 1)
}

TestingFactoryFn can be passed to testlg.NewWith to use zap as the backing impl.

Functions

This section is empty.

Types

type Log

type Log struct {
	*zap.SugaredLogger
	// contains filtered or unexported fields
}

Log wraps zap's logger, adding the WarnIf_ functions.

func New

func New() *Log

New returns a Log that writes to os.Stdout in text format, reporting the timestamp, level, and caller.

func NewWith

func NewWith(w io.Writer, format string, timestamp, utc, level, caller bool, addCallerSkip int) *Log

NewWith returns a Log that writes to w. Format should be one of "json", "text", or "testing"; defaults to "text". The timestamp, level and caller params determine if those fields are reported. If timestamp is true and utc is also true, the timestamp is displayed in UTC time. The addCallerSkip param is used to adjust the frame reported as the caller.

func (*Log) AddCallerSkip

func (l *Log) AddCallerSkip(skip int) lg.Log

AddCallerSkip adds additional caller skip.

func (*Log) WarnIfCloseError

func (l *Log) WarnIfCloseError(c io.Closer)

func (*Log) WarnIfError

func (l *Log) WarnIfError(err error)

func (*Log) WarnIfFuncError

func (l *Log) WarnIfFuncError(fn func() error)

func (*Log) With

func (l *Log) With(key string, val any) lg.Log

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL