edatlog

Documentation

Index

• type Config
• type Field
  • func Duration(key string, value time.Duration) Field
  • func Error(err error) Field
  • func Int(key string, value int) Field
  • func String(key string, value string) Field
• type FieldType
• type Level
• type Logger
  • func NewNopLogger() Logger

Types

type Config

type Config struct {
	Environment string
	LogLevel    Level
}

type EnvironmentConfig = func(options []zap.Option) zap.Config

type Field

type Field struct {
	Key      string
	Type     FieldType
	String   string
	Int      int
	Duration time.Duration
	Error    error
}

Field type

func Duration

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

Duration field value to time.Durations

func Error

func Error(err error) Field

Error field value for errors

func Int

func Int(key string, value int) Field

Int field value for ints

func String

func String(key string, value string) Field

String field value for strings

type FieldType

type FieldType int

FieldType loggable field types

const (
	StringType FieldType = iota
	IntType
	DurationType
	ErrorType
)

Loggable field types

type Level

type Level string

const (
	TRACE Level = "TRACE"
	DEBUG Level = "DEBUG"
	INFO  Level = "INFO"
	WARN  Level = "WARN"
	ERROR Level = "ERROR"
	PANIC Level = "PANIC"
)

type Logger

type Logger interface {
	Trace(msg string, fields ...Field)
	Debug(msg string, fields ...Field)
	Info(msg string, fields ...Field)
	Warn(msg string, fields ...Field)
	Error(msg string, fields ...Field)
	Sub(fields ...Field) Logger
}

Logger interface

var DefaultLogger Logger = NewNopLogger()

DefaultLogger is set to a Nop logger

You may reassign this if you wish to avoid having to pass in With*Logger(yourLogger) options into many of the constructors to set a custom logger

func NewNopLogger

func NewNopLogger() Logger

NewNopLogger returns a logger that logs to the void