log

Documentation

Index

• Variables
• func LogrusWrap(zr zerolog.Logger) *logrus.Logger
• type Logger
  • func LoggerFromConfig(name string, cfg *shared.Log) Logger
  • func NewLogger(opts ...Option) Logger
  • func NopLogger() Logger
  • func (l Logger) SubloggerWithRequestID(c context.Context) Logger
• type LogrusWrapper
  • func (h *LogrusWrapper) Fire(entry *logrus.Entry) error
  • func (h *LogrusWrapper) Levels() []logrus.Level
• type Option
  • func Color(val bool) Option
  • func File(val string) Option
  • func Level(val string) Option
  • func Name(val string) Option
  • func Pretty(val bool) Option
• type Options

Variables

var (
	RequestIDString = "request-id"
)

Functions

func LogrusWrap

func LogrusWrap(zr zerolog.Logger) *logrus.Logger

Wrap return a logrus logger which internally logs to /dev/null. Messages are passed to the underlying zerolog via hooks.

Types

type Logger

type Logger struct {
	zerolog.Logger
}

Logger simply wraps the zerolog logger.

func LoggerFromConfig

func LoggerFromConfig(name string, cfg *shared.Log) Logger

LoggerFromConfig initializes a service-specific logger instance.

func NewLogger

func NewLogger(opts ...Option) Logger

NewLogger initializes a new logger instance.

func NopLogger

func NopLogger() Logger

NopLogger initializes a no-operation logger.

func (Logger) SubloggerWithRequestID

func (l Logger) SubloggerWithRequestID(c context.Context) Logger

SubloggerWithRequestID returns a sublogger with the x-request-id added to all events

type LogrusWrapper

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

LogrusWrapper around zerolog. Required because idp uses logrus internally.

func (*LogrusWrapper) Fire

func (h *LogrusWrapper) Fire(entry *logrus.Entry) error

Fire called by logrus on new message

func (*LogrusWrapper) Levels

func (h *LogrusWrapper) Levels() []logrus.Level

Levels on which logrus hooks should be triggered

type Option

type Option func(o *Options)

Option defines a single option function.

func Color

func Color(val bool) Option

Color provides a function to set the color option.

func File

func File(val string) Option

File provides a function to set the file option.

func Level

func Level(val string) Option

Level provides a function to set the level option.

func Name

func Name(val string) Option

Name provides a function to set the name option.

func Pretty

func Pretty(val bool) Option

Pretty provides a function to set the pretty option.

type Options

type Options struct {
	Name   string
	Level  string
	Pretty bool
	Color  bool
	File   string
}

Options defines the available options for this package.