log

Documentation

Index

• Constants
• type Context
• type Fields
  • func (f Fields) Context() map[string]Valuer
• type Level
  • func (l Level) Context() map[string]Valuer
• type LoggedError
  • func (l LoggedError) Err() error
  • func (l LoggedError) Nil() error
• type Logger
  • func NewBufferLogger() (*strings.Builder, Logger)
  • func NewDefaultLogger() Logger
  • func NewJSONLogger() Logger
  • func NewLogger(writer log.Logger) Logger
  • func NewNopLogger() Logger
  • func NewTestLogger() Logger
• type Valuer
  • func Bool(b bool) Valuer
  • func ByteBase64(b []byte) Valuer
  • func ByteString(b []byte) Valuer
  • func Float32(f float32) Valuer
  • func Float64(f float64) Valuer
  • func Int(i int) Valuer
  • func Int64(i int64) Valuer
  • func Int64OrNil(i *int64) Valuer
  • func String(s string) Valuer
  • func StringOrNil(s *string) Valuer
  • func Stringer(s fmt.Stringer) Valuer
  • func Strings(vals []string) Valuer
  • func Time(t time.Time) Valuer
  • func TimeDuration(d time.Duration) Valuer
  • func TimeFormatted(t time.Time, format string) Valuer
  • func TimeOrNil(t *time.Time) Valuer
  • func Uint32(i uint32) Valuer
  • func Uint64(i uint64) Valuer

Constants

const Debug = Level("debug")

Info is sets level=info in the log output

const Error = Level("error")

Error sets level=error in the log output

const Fatal = Level("fatal")

Fatal sets level=fatal in the log output

const Info = Level("info")

Info is sets level=info in the log output

const StackTrace = st("stacktrace")

const Warn = Level("warn")

Info is sets level=warn in the log output

Types

type Context

type Context interface {
	Context() map[string]Valuer
}

type Fields

type Fields map[string]Valuer

func (Fields) Context

func (f Fields) Context() map[string]Valuer

type Level

type Level string

Level just wraps a string to be able to add Context specific to log levels

func (Level) Context

func (l Level) Context() map[string]Valuer

Context returns the map that states that key value of `level={{l}}`

type LoggedError

type LoggedError struct {
	// contains filtered or unexported fields
}

func (LoggedError) Err

func (l LoggedError) Err() error

func (LoggedError) Nil

func (l LoggedError) Nil() error

type Logger

type Logger interface {
	Set(key string, value Valuer) Logger
	With(ctxs ...Context) Logger
	Details() map[string]interface{}

	Debug() Logger
	Info() Logger
	Warn() Logger
	Error() Logger
	Fatal() Logger

	Log(message string)
	Logf(format string, args ...interface{})
	Send()

	LogError(error error) LoggedError
	LogErrorf(format string, args ...interface{}) LoggedError
}

func NewBufferLogger

func NewBufferLogger() (*strings.Builder, Logger)

func NewDefaultLogger

func NewDefaultLogger() Logger

func NewJSONLogger

func NewJSONLogger() Logger

func NewLogger

func NewLogger(writer log.Logger) Logger

func NewNopLogger

func NewNopLogger() Logger

func NewTestLogger

func NewTestLogger() Logger

type Valuer

type Valuer interface {
	// contains filtered or unexported methods
}

Valuer is an interface to deal with typing problems of just having an interface{} as the acceptable parameters Go-kit logging has a failure case if you attempt to throw any values into it. This is a way to guard our developers from having to worry about error cases of the lower logging framework.

func Bool

func Bool(b bool) Valuer

func ByteBase64

func ByteBase64(b []byte) Valuer

func ByteString

func ByteString(b []byte) Valuer

func Float32

func Float32(f float32) Valuer

func Float64

func Float64(f float64) Valuer

func Int

func Int(i int) Valuer

func Int64

func Int64(i int64) Valuer

func Int64OrNil

func Int64OrNil(i *int64) Valuer

func String

func String(s string) Valuer

func StringOrNil

func StringOrNil(s *string) Valuer

func Stringer

func Stringer(s fmt.Stringer) Valuer

func Strings

func Strings(vals []string) Valuer

func Time

func Time(t time.Time) Valuer

func TimeDuration

func TimeDuration(d time.Duration) Valuer

func TimeFormatted

func TimeFormatted(t time.Time, format string) Valuer

func TimeOrNil

func TimeOrNil(t *time.Time) Valuer

func Uint32

func Uint32(i uint32) Valuer

func Uint64

func Uint64(i uint64) Valuer