logger

package
v1.0.6 Latest Latest
Warning

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

 Go to latest Published: Jan 22, 2025 License: MIT Imports: 15 Imported by: 4

Documentation

Overview

Package logger Provides structured & deprecated unstructured logging facade to facilitate logging to different providers and multiple instances.

Index

Constants

View Source 
const (
	DefaultAppShortName = "hello-world"
)

Variables

This section is empty.

Functions

func WithAllValues 

func WithAllValues(toCtx context.Context, fromCtxWithValues context.Context) context.Context

func WithFields 

func WithFields(ctx context.Context, newFields ...Field) context.Context

func WithLogger 

func WithLogger(ctx context.Context, logger *Logger) context.Context

func WithoutFields added in v1.0.2 

func WithoutFields(ctx context.Context) context.Context

Types

type ContextFields 

type ContextFields struct {
	// contains filtered or unexported fields
}

type ContextLogger 

type ContextLogger struct {
	// contains filtered or unexported fields
}

func Of 

func Of(ctx context.Context) (clogger *ContextLogger, err error)

func OfMust 

func OfMust(ctx context.Context) (clogger *ContextLogger)

func (*ContextLogger) DPanic 

func (s *ContextLogger) DPanic(msg string, fields ...Field)

func (*ContextLogger) Debug 

func (s *ContextLogger) Debug(msg string, fields ...Field)

func (*ContextLogger) Error 

func (s *ContextLogger) Error(msg string, fields ...Field)

func (*ContextLogger) ErrorIgnoreCancel 

func (s *ContextLogger) ErrorIgnoreCancel(ctx context.Context, msg string, fields ...Field)

func (*ContextLogger) Fatal 

func (s *ContextLogger) Fatal(msg string, fields ...Field)

func (*ContextLogger) Info 

func (s *ContextLogger) Info(msg string, fields ...Field)

func (*ContextLogger) InfoIgnoreCancel 

func (s *ContextLogger) InfoIgnoreCancel(ctx context.Context, msg string, fields ...Field)

func (*ContextLogger) Logger added in v1.0.5 

func (s *ContextLogger) Logger() *Logger

func (*ContextLogger) Panic 

func (s *ContextLogger) Panic(msg string, fields ...Field)

func (*ContextLogger) Trace 

func (s *ContextLogger) Trace(msg string, fields ...Field)

func (*ContextLogger) Warn 

func (s *ContextLogger) Warn(msg string, fields ...Field)

func (*ContextLogger) WarnIgnoreCancel 

func (s *ContextLogger) WarnIgnoreCancel(ctx context.Context, msg string, fields ...Field)

type Field 

type Field zapcore.Field

func Any 

func Any(key string, value interface{}) Field

Any takes a key and an arbitrary value and chooses the best way to represent them as a field, falling back to a reflection-based approach only if necessary.

Since byte/uint8 and rune/int32 are aliases, Any can't differentiate between them. To minimize surprises, []byte values are treated as binary blobs, byte values are treated as uint8, and runes are always treated as integers

func Binary 

func Binary(key string, val []byte) Field

Binary constructs a field that carries an opaque binary blob.

Binary data is serialized in an encoding-appropriate format. For example, zap's JSON encoder base64-encodes binary blobs. To log UTF-8 encoded text, use ByteString.

func Bool 

func Bool(key string, val bool) Field

Bool constructs a field that carries a bool.

func Boolp 

func Boolp(key string, val *bool) Field

Boolp constructs a field that carries a *bool. The returned Field will safely and explicitly represent `nil` when appropriate.

func ByteString 

func ByteString(key string, val []byte) Field

ByteString constructs a field that carries UTF-8 encoded text as a []byte. To log opaque binary blobs (which aren't necessarily valid UTF-8), use Binary.

func Complex128 

func Complex128(key string, val complex128) Field

Complex128 constructs a field that carries a complex number. Unlike most numeric fields, this costs an allocation (to convert the complex128 to interface{}).

func Complex128p 

func Complex128p(key string, val *complex128) Field

Complex128p constructs a field that carries a *complex128. The returned Field will safely and explicitly represent `nil` when appropriate.

func Complex64 

func Complex64(key string, val complex64) Field

Complex64 constructs a field that carries a complex number. Unlike most numeric fields, this costs an allocation (to convert the complex64 to interface{}).

func Complex64p 

func Complex64p(key string, val *complex64) Field

Complex64p constructs a field that carries a *complex64. The returned Field will safely and explicitly represent `nil` when appropriate.

func Duration 

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

Duration constructs a field with the given key and value. The encoder controls how the duration is serialized.

func Durationp 

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

Durationp constructs a field that carries a *time.Duration. The returned Field will safely and explicitly represent `nil` when appropriate.

func Error 

func Error(err error) Field

Error is shorthand for the common idiom NamedError("error", err).

func Float32 

func Float32(key string, val float32) Field

Float32 constructs a field that carries a float32. The way the floating-point value is represented is encoder-dependent, so marshaling is necessarily lazy.

func Float32p 

func Float32p(key string, val *float32) Field

Float32p constructs a field that carries a *float32. The returned Field will safely and explicitly represent `nil` when appropriate.

func Float64 

func Float64(key string, val float64) Field

Float64 constructs a field that carries a float64. The way the floating-point value is represented is encoder-dependent, so marshaling is necessarily lazy.

func Float64p 

func Float64p(key string, val *float64) Field

Float64p constructs a field that carries a *float64. The returned Field will safely and explicitly represent `nil` when appropriate.

func Inline 

func Inline(val zapcore.ObjectMarshaler) Field

Inline constructs a Field that is similar to Object, but it will add the elements of the provided ObjectMarshaler to the current namespace.

func Int 

func Int(key string, val int) Field

Int constructs a field with the given key and value.

func Int16 

func Int16(key string, val int16) Field

Int16 constructs a field with the given key and value.

func Int16p 

func Int16p(key string, val *int16) Field

Int16p constructs a field that carries a *int16. The returned Field will safely and explicitly represent `nil` when appropriate.

func Int32 

func Int32(key string, val int32) Field

Int32 constructs a field with the given key and value.

func Int32p 

func Int32p(key string, val *int32) Field

Int32p constructs a field that carries a *int32. The returned Field will safely and explicitly represent `nil` when appropriate.

func Int64 

func Int64(key string, val int64) Field

Int64 constructs a field with the given key and value.

func Int64p 

func Int64p(key string, val *int64) Field

Int64p constructs a field that carries a *int64. The returned Field will safely and explicitly represent `nil` when appropriate.

func Int8 

func Int8(key string, val int8) Field

Int8 constructs a field with the given key and value.

func Int8p 

func Int8p(key string, val *int8) Field

Int8p constructs a field that carries a *int8. The returned Field will safely and explicitly represent `nil` when appropriate.

func Intp 

func Intp(key string, val *int) Field

Intp constructs a field that carries a *int. The returned Field will safely and explicitly represent `nil` when appropriate.

func NamedError 

func NamedError(key string, err error) Field

NamedError constructs a field that lazily stores err.Error() under the provided key. Errors which also implement fmt.Formatter (like those produced by github.com/pkg/errors) will also have their verbose representation stored under key+"Verbose". If passed a nil error, the field is a no-op.

For the common case in which the key is simply "error", the Error function is shorter and less repetitive.

func Namespace 

func Namespace(key string) Field

Namespace creates a named, isolated scope within the logger's context. All subsequent fields will be added to the new namespace.

This helps prevent key collisions when injecting loggers into sub-components or third-party libraries.

func Object 

func Object(key string, val zapcore.ObjectMarshaler) Field

Object constructs a field with the given key and ObjectMarshaler. It provides a flexible, but still type-safe and efficient, way to add map- or struct-like user-defined types to the logging context. The struct's MarshalLogObject method is called lazily.

func Reflect 

func Reflect(key string, val interface{}) Field

Reflect constructs a field with the given key and an arbitrary object. It uses an encoding-appropriate, reflection-based function to lazily serialize nearly any object into the logging context, but it's relatively slow and allocation-heavy. Outside tests, Any is always a better choice.

If encoding fails (e.g., trying to serialize a map[int]string to JSON), Reflect includes the error message in the final log output.

func Skip 

func Skip() Field

Skip constructs a no-op field, which is often useful when handling invalid inputs in other Field constructors.

func Stack 

func Stack(key string) Field

Stack constructs a field that stores a stacktrace of the current goroutine under provided key. Keep in mind that taking a stacktrace is eager and expensive (relatively speaking); this function both makes an allocation and takes about two microseconds.

func StackSkip 

func StackSkip(key string, skip int) Field

StackSkip constructs a field similarly to Stack, but also skips the given number of frames from the top of the stacktrace.

func String 

func String(key string, val string) Field

String constructs a field with the given key and value.

func Stringer 

func Stringer(key string, val fmt.Stringer) Field

Stringer constructs a field with the given key and the output of the value's String method. The Stringer's String method is called lazily.

func Stringp 

func Stringp(key string, val *string) Field

Stringp constructs a field that carries a *string. The returned Field will safely and explicitly represent `nil` when appropriate.

func Time 

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

Time constructs a Field with the given key and value. The encoder controls how the time is serialized.

func Timep 

func Timep(key string, val *time.Time) Field

Timep constructs a field that carries a *time.Time. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uint 

func Uint(key string, val uint) Field

Uint constructs a field with the given key and value.

func Uint16 

func Uint16(key string, val uint16) Field

Uint16 constructs a field with the given key and value.

func Uint16p 

func Uint16p(key string, val *uint16) Field

Uint16p constructs a field that carries a *uint16. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uint32 

func Uint32(key string, val uint32) Field

Uint32 constructs a field with the given key and value.

func Uint32p 

func Uint32p(key string, val *uint32) Field

Uint32p constructs a field that carries a *uint32. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uint64 

func Uint64(key string, val uint64) Field

Uint64 constructs a field with the given key and value.

func Uint64p 

func Uint64p(key string, val *uint64) Field

Uint64p constructs a field that carries a *uint64. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uint8 

func Uint8(key string, val uint8) Field

Uint8 constructs a field with the given key and value.

func Uint8p 

func Uint8p(key string, val *uint8) Field

Uint8p constructs a field that carries a *uint8. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uintp 

func Uintp(key string, val *uint) Field

Uintp constructs a field that carries a *uint. The returned Field will safely and explicitly represent `nil` when appropriate.

func Uintptr 

func Uintptr(key string, val uintptr) Field

Uintptr constructs a field with the given key and value.

func Uintptrp 

func Uintptrp(key string, val *uintptr) Field

Uintptrp constructs a field that carries a *uintptr. The returned Field will safely and explicitly represent `nil` when appropriate.

type Level 

type Level int8

A Level is a logging priority. Higher levels are more important. 

const (
	// DebugLevel logs are typically voluminous, and are usually disabled in
	// production.
	DebugLevel Level = iota - 1
	// InfoLevel is the default logging priority.
	InfoLevel
	// WarnLevel logs are more important than Info, but don't need individual
	// human review.
	WarnLevel
	// ErrorLevel logs are high-priority. If an application is running smoothly,
	// it shouldn't generate any error-level logs.
	ErrorLevel
	// DPanicLevel logs are particularly important errors. In development the
	// logger panics after writing the message.
	DPanicLevel
	// PanicLevel logs a message, then panics.
	PanicLevel
	// FatalLevel logs a message, then calls os.Exit(1).
	FatalLevel
)

type LogInstance 

type LogInstance struct {
	// contains filtered or unexported fields
}

type Logger 

type Logger struct {
	// contains filtered or unexported fields
}

func Instance 

func Instance() *Logger

Instance deprecated

func NewLogger 

func NewLogger() *Logger

func (*Logger) AddLogger 

func (s *Logger) AddLogger(key string, w io.Writer, newLevel Level, opts ...LoggingOption)

func (*Logger) DPanic 

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

func (*Logger) DPanicUnstruct deprecated 

func (s *Logger) DPanicUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) DPanicfUnstruct deprecated 

func (s *Logger) DPanicfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) Debug 

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

func (*Logger) DebugUnstruct deprecated 

func (s *Logger) DebugUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) DebugfUnstruct deprecated 

func (s *Logger) DebugfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) Error 

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

func (*Logger) ErrorIgnoreCancel 

func (s *Logger) ErrorIgnoreCancel(ctx context.Context, msg string, fields ...Field)

func (*Logger) ErrorIgnoreCancelUnstruct deprecated 

func (s *Logger) ErrorIgnoreCancelUnstruct(ctx context.Context, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) ErrorInLoggerWriter 

func (s *Logger) ErrorInLoggerWriter(format string, args ...interface{})

ErrorInLoggerWriter is used by log Writer sinks added with AddLogger() to log messages to standard console & file instances that are enabled so the error in the logger can be trapped somewhere and without an error loop in the logger that triggered it

func (*Logger) ErrorInLoggerWriterIgnoreCancel 

func (s *Logger) ErrorInLoggerWriterIgnoreCancel(ctx context.Context, format string, args ...interface{})

func (*Logger) ErrorUnstruct deprecated 

func (s *Logger) ErrorUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) ErrorfIgnoreCancelUnstruct deprecated 

func (s *Logger) ErrorfIgnoreCancelUnstruct(ctx context.Context, format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) ErrorfUnstruct deprecated 

func (s *Logger) ErrorfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) Fatal 

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

func (*Logger) FatalUnstruct deprecated 

func (s *Logger) FatalUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) FatalfUnstruct deprecated 

func (s *Logger) FatalfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) Info 

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

func (*Logger) InfoIgnoreCancel 

func (s *Logger) InfoIgnoreCancel(ctx context.Context, msg string, fields ...Field)

func (*Logger) InfoUnstruct deprecated 

func (s *Logger) InfoUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) InfofUnstruct deprecated 

func (s *Logger) InfofUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) IsLevelEnabled 

func (s *Logger) IsLevelEnabled(level Level) bool

func (*Logger) Panic 

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

func (*Logger) PanicUnstruct deprecated 

func (s *Logger) PanicUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) PanicfUnstruct deprecated 

func (s *Logger) PanicfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) SetConsoleLogLevel 

func (s *Logger) SetConsoleLogLevel(newLevel Level)

func (*Logger) SetConsoleLogging 

func (s *Logger) SetConsoleLogging(enabled bool)

func (*Logger) SetFileLogLevel 

func (s *Logger) SetFileLogLevel(newLevel Level)

func (*Logger) SetFileLogging 

func (s *Logger) SetFileLogging(enabled bool)

func (*Logger) SetJsonStdoutLogLevel 

func (s *Logger) SetJsonStdoutLogLevel(newLevel Level)

func (*Logger) SetJsonStdoutLogging 

func (s *Logger) SetJsonStdoutLogging(enabled bool)

func (*Logger) SetLogLevel 

func (s *Logger) SetLogLevel(key string, newLevel Level)

func (*Logger) SetLoggerEnabled 

func (s *Logger) SetLoggerEnabled(key string, enabled bool)

func (*Logger) StartTask 

func (s *Logger) StartTask(opts ...LoggingOption)

func (*Logger) StopTask 

func (s *Logger) StopTask()

func (*Logger) Sync 

func (s *Logger) Sync()

func (*Logger) Trace 

func (s *Logger) Trace(msg string, fields ...Field)

func (*Logger) TraceUnstruct deprecated 

func (s *Logger) TraceUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) TracefUnstruct deprecated 

func (s *Logger) TracefUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) Warn 

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

func (*Logger) WarnIgnoreCancel 

func (s *Logger) WarnIgnoreCancel(ctx context.Context, msg string, fields ...Field)

func (*Logger) WarnIgnoreCancelUnstruct deprecated 

func (s *Logger) WarnIgnoreCancelUnstruct(ctx context.Context, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) WarnUnstruct deprecated 

func (s *Logger) WarnUnstruct(args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) WarnfIgnoreCancelUnstruct deprecated 

func (s *Logger) WarnfIgnoreCancelUnstruct(ctx context.Context, format string, args ...interface{})

Deprecated: use structured logging instead.

func (*Logger) WarnfUnstruct deprecated 

func (s *Logger) WarnfUnstruct(format string, args ...interface{})

Deprecated: use structured logging instead.

type LoggingOption 

type LoggingOption func(o *Options)

func WithProductNameShort 

func WithProductNameShort(productNameShort string) LoggingOption

WithProductNameShort sets the name of your product used in log file names. example: logger.Instance().StartTask(logger.WithProductNameShort("your-product-name-here"))

func WithSampling 

func WithSampling(samplingOptions SamplingOptions) LoggingOption

type Options 

type Options struct {
	// contains filtered or unexported fields
}

type SamplingOptions 

type SamplingOptions struct {
	Tick       time.Duration
	First      int
	Thereafter int
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.