logging

Documentation

Overview

The logging package is a wrapper around github.com/sirupsen/logrus that provides some convenience methods and improved error reporting.

Index

• Constants
• Variables
• type Logger
  • func NewLogger(baseFields logrus.Fields) Logger
  • func TestLogger() Logger
  • func (l Logger) AddHook(outType OutType, dest string) error
  • func (l Logger) NoFields() Logger
  • func (l Logger) SetLogOut(out io.Writer)
  • func (l Logger) SubLogger(fields logrus.Fields) Logger
  • func (l Logger) WithError(err error) Logger
  • func (l Logger) WithErrorAndFields(err error, fields logrus.Fields) Logger
  • func (l Logger) WithField(key string, value interface{}) Logger
  • func (l Logger) WithFields(fields logrus.Fields) Logger
• type OutType
• type ProcessCounter
  • func (p *ProcessCounter) Fire(entry *logrus.Entry) error
  • func (ProcessCounter) Levels() []logrus.Level
• type SocketHook
  • func (s SocketHook) Fire(entry *logrus.Entry) error
  • func (SocketHook) Levels() []logrus.Level

Constants

const (
	OutSocket = OutType("socket")
)

Recognized output hook types

Variables

var DefaultLogger = NewLogger(logrus.Fields{})

Types

type Logger

type Logger struct {
	*logrus.Entry
}

Logger is a thin wrapper around a logrus.Entry that lets us extend and override some of Entry's methods.

func NewLogger

func NewLogger(baseFields logrus.Fields) Logger

func TestLogger

func TestLogger() Logger

func (Logger) AddHook

func (l Logger) AddHook(outType OutType, dest string) error

func (Logger) NoFields

func (l Logger) NoFields() Logger

func (Logger) SetLogOut

func (l Logger) SetLogOut(out io.Writer)

func (Logger) SubLogger

func (l Logger) SubLogger(fields logrus.Fields) Logger

func (Logger) WithError

func (l Logger) WithError(err error) Logger

func (Logger) WithErrorAndFields

func (l Logger) WithErrorAndFields(err error, fields logrus.Fields) Logger

func (Logger) WithField

func (l Logger) WithField(key string, value interface{}) Logger

func (Logger) WithFields

func (l Logger) WithFields(fields logrus.Fields) Logger

type OutType

type OutType string

type ProcessCounter

type ProcessCounter struct{}

ProcessCounter is a Logrus hook that appends a sequence number to all entries. This hook should appear before other hooks that externalize data, to ensure that they see the added fields.

func (*ProcessCounter) Fire

func (p *ProcessCounter) Fire(entry *logrus.Entry) error

func (ProcessCounter) Levels

func (ProcessCounter) Levels() []logrus.Level

type SocketHook

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

func (SocketHook) Fire

func (s SocketHook) Fire(entry *logrus.Entry) error

func (SocketHook) Levels

func (SocketHook) Levels() []logrus.Level