onqlavelogger

package

v0.1.0 Latest Latest Go to latest Published: May 24, 2023 License: MIT Imports: 6 Imported by: 0

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/onqlavelabs/onqlave-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Filter
type Logger
- func NewLog(name string, options ...Option) *Logger
type Option

Constants ¶

View Source

const (
	FieldCorrelationID = "cid"
	FieldError         = "error"
	FieldRootError     = "root_error"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Filter ¶

type Filter interface {
	DoFilter(any) any
	IsFilter(string, any) bool
}

type Logger ¶

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

A Logger provides fast, leveled, structured logging. All methods are safe for concurrent use, along with filter policy to synthesis logging data.

func NewLog ¶

func NewLog(name string, options ...Option) *Logger

NewLog create a new logger instance with default Zap logging production config and a logging scope based on the given name parameter. Custom logging option enables filter policy, correlationID and other configuration for logger. Logging is enabled at Info Level and above.

For further logging function. please refer to: https://pkg.go.dev/go.uber.org/zap

Example: Create a new logger with name "tenant-service", and filter policy to redact value from "email" fields. logger.NewLog("tenant-service", logger.WithFilters(filter.Field("email")))

func (*Logger) GetCid ¶

func (l *Logger) GetCid() string

func (*Logger) WithCid ¶

func (l *Logger) WithCid(cid string) *Logger

func (*Logger) WithErr ¶

func (l *Logger) WithErr(err error) *Logger

func (*Logger) WithFields ¶

func (l *Logger) WithFields(fields map[string]any) *Logger

type Option ¶

type Option func(*Logger)

func WithCid ¶

func WithCid(cid string) Option

func WithDevelopment ¶

func WithDevelopment(isDevelop bool) Option

func WithDurationEncoder ¶

func WithDurationEncoder(encoder zapcore.DurationEncoder) Option

func WithFilters ¶

func WithFilters(filters ...Filter) Option

func WithLevel ¶

func WithLevel(level zapcore.Level) Option

func WithTimeEncoder ¶

func WithTimeEncoder(encoder zapcore.TimeEncoder) Option

Source Files ¶

View all Source files

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