log

Documentation

Overview

Package log to define custom logger

Index

• Variables
• func SetLogger(instance Store)
• func Setup(ctx context.Context, opts *Options)
• type Logger
  • func Bg() Logger
  • func For(ctx context.Context) Logger
• type Options
• type Store
  • func Default() Store
  • func NewStore(logger *zap.Logger) Store

Variables

var DefaultOptions = &Options{
	Debug:    true,
	LogLevel: "info",
}

DefaultOptions define default options

Functions

func SetLogger

func SetLogger(instance Store)

SetLogger defines the default package logger

func Setup

func Setup(ctx context.Context, opts *Options)

Setup our 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)
	Panic(msg string, fields ...zapcore.Field)
}

Logger defines all the available levels

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 Options

type Options struct {
	Debug    bool
	LogLevel string
}

Options defines the options available for the logger

type Store

type Store interface {
	Bg() Logger
	For(context.Context) Logger
}

Store define the default store of the logger

func Default

func Default() Store

Default returns the logger factory

func NewStore

func NewStore(logger *zap.Logger) Store

NewStore creates a new instance of a Store