logger

README

Logger

This logger basically configure zerolog so that you can log via github.com/rs/zerolog/log

Usage

Import shared/logger package. It will be self-initialized.

import  "github.com/xmlking/micro-starter-kit/shared/logger"

Your can set Logger config via Environment Variables: CONFIGOR_LOG_LEVEL , CONFIGOR_LOG_FORMAT

Test

CONFIGOR_LOG_LEVEL=info CONFIGOR_LOG_FORMAT=json go test github.com/xmlking/micro-starter-kit/shared/logger  -count=1

Documentation

Index

• func Init(options ...Option) error
• type Format
  • func ParseFormat(formatStr string) (Format, error)
• type Logger
  • func NewLogger(opts ...Option) Logger
• type Option
  • func ReportCaller() Option
  • func SetOption(k, v interface{}) Option
  • func WithFields(fields map[string]interface{}) Option
  • func WithFormat(format Format) Option
  • func WithLevel(level zerolog.Level) Option
  • func WithOutput(out io.Writer) Option
  • func WithTimeFormat(timeFormat string) Option
• type Options

Functions

func Init

func Init(options ...Option) error

Helper functions on DefaultLogger

Types

type Format

type Format string

Log format enum.

const (
	PRETTY Format = "pretty"
	JSON   Format = "json"
	GCP    Format = "gcp"
	AZURE  Format = "azure"
	AWS    Format = "aws"
)

func ParseFormat

func ParseFormat(formatStr string) (Format, error)

type Logger

type Logger interface {
	Init(options ...Option) error
	Options() Options
	String() string
}

var (
	// Default Logger
	DefaultLogger Logger
)

func NewLogger

func NewLogger(opts ...Option) Logger

type Option

type Option func(*Options)

func ReportCaller

func ReportCaller() Option

ReportCaller set value to `true`

func SetOption

func SetOption(k, v interface{}) Option

func WithFields

func WithFields(fields map[string]interface{}) Option

WithFields set default fields for the logger

func WithFormat

func WithFormat(format Format) Option

WithFormat set default log format for the logger

func WithLevel

func WithLevel(level zerolog.Level) Option

WithLevel set default level for the logger

func WithOutput

func WithOutput(out io.Writer) Option

WithOutput set default output writer for the logger

func WithTimeFormat

func WithTimeFormat(timeFormat string) Option

WithTimeFormat set default timeFormat for the logger

type Options

type Options struct {
	// The logging level the logger should log at. default is `InfoLevel`
	Level zerolog.Level
	// Log format. default `json`
	Format Format
	// TimeFormat is one of time.RFC3339, time.RFC3339Nano, time.*
	TimeFormat string
	// Flag for whether to log caller info (off by default)
	ReportCaller bool
	// fields to always be logged
	Fields map[string]interface{}
	// It's common to set this to a file, or leave it default which is `os.Stderr`
	Out io.Writer
	// Alternative options
	Context context.Context
}