log

package

v0.1.3 Latest Latest Go to latest Published: May 9, 2024 License: MIT Imports: 5 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kwilteam/kwil-db

Documentation ¶

Constants ¶

View Source

const (
	FormatJSON  = "json"
	FormatPlain = "plain"
)

View Source

const (
	TimeEncodingRFC3339Milli = "rfc3339milli"
	TimeEncodingEpochMilli   = "epochmilli"
	TimeEncodingEpochFloat   = "epochfloat"
)

View Source

const (
	DebugLevel  Level = zap.DebugLevel
	InfoLevel         = zap.InfoLevel
	WarnLevel         = zap.WarnLevel
	ErrorLevel        = zap.ErrorLevel
	DPanicLevel       = zap.DPanicLevel
	PanicLevel        = zap.PanicLevel
	FatalLevel        = zap.FatalLevel
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Level string
	// OutputPaths is a list of URLs or file paths to write logging output to.
	OutputPaths []string
	// Format is either EncodingJSON or EncodingConsole.
	Format string
	// EncodeTime indicates how to encode the time. The default is
	// TimeEncodingEpochFloat.
	EncodeTime string
}

type Field ¶

type Field = zap.Field

func Any ¶

func Any(key string, val any) Field

func Bool ¶

func Bool(key string, val bool) Field

func Duration ¶

func Duration(key string, val time.Duration) Field

func Float ¶

func Float[T float32 | float64](key string, val T) Field

func Int ¶

func Int[T int | int64 | int32 | int16 | int8](key string, val T) Field

func String ¶

func String(key, val string) Field

func Uint ¶

func Uint[T uint | uint64 | uint32 | uint16 | uint8](key string, val T) Field

type Level ¶

type Level = zapcore.Level

type Logger ¶

type Logger struct {
	L *zap.Logger
}

Logger is a wrapper around zap.Logger, which adds some additional fields to critical log messages.

func New ¶

func New(config Config) Logger

func NewChecked ¶

func NewChecked(config Config) (Logger, error)

func NewNoOp ¶

func NewNoOp() Logger

NoOp is a logger that does nothing. It is useful for testing, or for user packages where we want to have logging configurable.

func NewStdOut ¶

func NewStdOut(level Level) Logger

func (*Logger) DPanic ¶

func (l *Logger) DPanic(msg string, fields ...Field)

func (*Logger) Debug ¶

func (l *Logger) Debug(msg string, fields ...Field)

func (*Logger) Debugf ¶

func (l *Logger) Debugf(msg string, args ...any)

func (*Logger) Error ¶

func (l *Logger) Error(msg string, fields ...Field)

func (*Logger) Errorf ¶

func (l *Logger) Errorf(msg string, args ...any)

func (*Logger) Fatal ¶

func (l *Logger) Fatal(msg string, fields ...Field)

func (*Logger) Info ¶

func (l *Logger) Info(msg string, fields ...Field)

func (*Logger) Infof ¶

func (l *Logger) Infof(msg string, args ...any)

func (*Logger) Level ¶

func (l *Logger) Level() Level

func (*Logger) Log ¶

func (l *Logger) Log(level Level, msg string, fields ...Field)

func (*Logger) Logf ¶

func (l *Logger) Logf(level Level, msg string, args ...any)

func (*Logger) Named ¶

func (l *Logger) Named(name string) *Logger

func (*Logger) Panic ¶

func (l *Logger) Panic(msg string, fields ...Field)

func (Logger) Sugar ¶

func (l Logger) Sugar() SugaredLogger

func (*Logger) Sync ¶

func (l *Logger) Sync() error

func (*Logger) Warn ¶

func (l *Logger) Warn(msg string, fields ...Field)

func (*Logger) Warnf ¶

func (l *Logger) Warnf(msg string, args ...any)

func (*Logger) With ¶

func (l *Logger) With(fields ...Field) *Logger

func (*Logger) WithOptions ¶

func (l *Logger) WithOptions(opts ...zap.Option) *Logger

type SugaredLogger ¶

type SugaredLogger struct {
	S *zap.SugaredLogger
}

func (*SugaredLogger) Debug ¶

func (s *SugaredLogger) Debug(msg string, fields ...any)

func (*SugaredLogger) Error ¶

func (s *SugaredLogger) Error(msg string, fields ...any)

func (*SugaredLogger) Info ¶

func (s *SugaredLogger) Info(msg string, fields ...any)

func (*SugaredLogger) Level ¶

func (s *SugaredLogger) Level() Level

func (*SugaredLogger) Named ¶

func (s *SugaredLogger) Named(name string) *SugaredLogger

func (*SugaredLogger) Sync ¶

func (s *SugaredLogger) Sync() error

func (*SugaredLogger) Warn ¶

func (s *SugaredLogger) Warn(msg string, fields ...any)

Source Files ¶

View all Source files

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