logger

Documentation

Index

• Variables
• func LogErrorWithBody(ctx context.Context, err error, errName, responseBody string)
• func NewKievRequestLogger(appName string) func(http.HandlerFunc) http.HandlerFunc
• type Context
• type Level
• type LoggedEvent
  • func Error(name string, err error) *LoggedEvent
  • func Event(name string) *LoggedEvent
• type Logger
  • func Get(ctx context.Context) Logger
  • func New(ctx context.Context, appName string) (Logger, context.Context)
  • func NewLambdaLogger(ctx context.Context) (Logger, context.Context)
  • func NewRequestLogger(appName string, req *http.Request) (Logger, context.Context)
  • func NewStandalone(appName string) (Logger, context.Context)

Variables

var DefaultLogger defaultLogger

DefaultLogger represents everywhere available logger with default LogSink. It is also used with package logger.Event(...) method executions.

var LogSink io.Writer

LogSink points to the writer that store all logs, default one is os.Stdout If you want to have it different, just set it prior using any `logger.New*(...)` function

Functions

func LogErrorWithBody

func LogErrorWithBody(ctx context.Context, err error, errName, responseBody string)

LogErrorWithBody updates logging context with details of the error and responseBody payload. This is later dumped with the request_finished event

func NewKievRequestLogger

func NewKievRequestLogger(appName string) func(http.HandlerFunc) http.HandlerFunc

NewKievRequestLogger creates a middleware that can wrap `http.HandlerFunc` of your server with logger inside of the `request.Context()`.

Types

type Context

type Context = zerolog.Context

Context is a type-alias for zerolog.Context

type Level

type Level = zerolog.Level

Level is a type-alias for zerolog.Level

type LoggedEvent

type LoggedEvent = zerolog.Event

LoggedEvent is a type-alias for zerolog.Event

func Error

func Error(name string, err error) *LoggedEvent

Event package function logs message with DefaultLogger on loglevel error

func Event

func Event(name string) *LoggedEvent

Event package function logs message with DefaultLogger

type Logger

type Logger interface {
	WithScope(map[string]interface{})
	IsDisabled() bool
	// contains filtered or unexported methods
}

Logger is an interface for the returned logger instance

func Get

func Get(ctx context.Context) Logger

Get returns Logger instance from the argument representing current `context.Context`. Useful to get the logger instance downstream somewhere deep in your app. Then you pass just the context instance all way down and get the `Logger` out using this function.

func New

func New(ctx context.Context, appName string) (Logger, context.Context)

New creates a logger with appName specified and attaches it to the provided ctx and the enriched context is returned as second value. If already logger exists in the context it returns it as it is.

func NewLambdaLogger

func NewLambdaLogger(ctx context.Context) (Logger, context.Context)

NewLambdaLogger returns a logger and enhanced context which is ready to log details of request in JSON responses compatible with Kiev format.

func NewRequestLogger

func NewRequestLogger(appName string, req *http.Request) (Logger, context.Context)

NewRequestLogger registers logger on the request and it's context and loads the logger scope from the request context.

func NewStandalone

func NewStandalone(appName string) (Logger, context.Context)

NewStandalone creates a logger with appName in fresh Context( `context.Background()` ) return as 2nd value