log

package module

v0.2.0 Latest Latest Go to latest Published: Aug 13, 2019 License: MIT Imports: 6 Imported by: 21

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

Repository URL not available.

Documentation ¶

Index ¶

Variables
func CheckErr(msg string, err error, fields ...zapcore.Field)
func CheckErrCtx(ctx context.Context, msg string, err error, fields ...zapcore.Field)
func SafeClose(c io.Closer, msg string, fields ...zapcore.Field)
func SafeCloseCtx(ctx context.Context, c io.Closer, msg string, fields ...zapcore.Field)
func SetLoggerFactory(instance LoggerFactory)
func Setup(ctx context.Context, opts Options)
type Logger
- func Bg() Logger
- func For(ctx context.Context) Logger
type LoggerFactory
- func Default() LoggerFactory
- func NewFactory(logger *zap.Logger) LoggerFactory
type Options

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultOptions = &Options{
	Debug:     false,
	LogLevel:  "info",
	AppName:   "changeme",
	AppID:     "changeme",
	Version:   "0.0.1",
	Revision:  "123456789",
	SentryDSN: "",
}

DefaultOptions defines default logger options

Functions ¶

func CheckErr ¶

func CheckErr(msg string, err error, fields ...zapcore.Field)

CheckErr handles error correctly

func CheckErrCtx ¶

func CheckErrCtx(ctx context.Context, msg string, err error, fields ...zapcore.Field)

CheckErrCtx handles error correctly

func SafeClose ¶

func SafeClose(c io.Closer, msg string, fields ...zapcore.Field)

SafeClose handles the closer error

func SafeCloseCtx ¶ added in v0.1.0

func SafeCloseCtx(ctx context.Context, c io.Closer, msg string, fields ...zapcore.Field)

SafeCloseCtx handles the closer error

func SetLoggerFactory ¶ added in v0.1.1

func SetLoggerFactory(instance LoggerFactory)

SetLoggerFactory defines the default package logger

func Setup ¶

func Setup(ctx context.Context, opts Options)

Setup the logger

Types ¶

type Logger ¶

type Logger interface {
	Debug(msg string, fields ...zapcore.Field)
	Info(msg string, fields ...zapcore.Field)
	Warn(msg string, fields ...zapcore.Field)
	Error(msg string, fields ...zapcore.Field)
	Fatal(msg string, fields ...zapcore.Field)
	With(fields ...zapcore.Field) Logger
}

Logger is a simplified abstraction of the zap.Logger

func Bg ¶

func Bg() Logger

Bg delegates a no-context logger

func For ¶

func For(ctx context.Context) Logger

For delegates a context logger

type LoggerFactory ¶

type LoggerFactory interface {
	Name() string
	Bg() Logger
	For(context.Context) Logger
	With(...zapcore.Field) LoggerFactory
}

LoggerFactory defines logger factory contract

func Default ¶

func Default() LoggerFactory

Default returns the logger factory

func NewFactory ¶

func NewFactory(logger *zap.Logger) LoggerFactory

NewFactory creates a new Factory.

type Options ¶

type Options struct {
	Debug     bool
	LogLevel  string
	AppName   string
	AppID     string
	Version   string
	Revision  string
	SentryDSN string
}

Options declares logger options for builder

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
adapters
zap Module
zap module

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