log

Documentation

Overview

Package log provides the common logging facilities used by the Rover Development foundation.

You may notice that this package does not expose the "Fatal" family of logging functions: this is intentional. This package is specifically geared to logging within the context of an http server, and our chosen path for responding to "Oh my god something is horribly wrong" within the context of an HTTP request is to panic on that request.

Index

• Constants
• func Debug(args ...interface{})
• func Debugf(format string, args ...interface{})
• func Error(args ...interface{})
• func Errorf(format string, args ...interface{})
• func HTTPMiddleware(in http.Handler) http.Handler
• func Info(args ...interface{})
• func Infof(format string, args ...interface{})
• func Panic(args ...interface{})
• func Panicf(format string, args ...interface{})
• func PushContext(parent context.Context, modFn func(*Entry) *Entry) context.Context
• func Set(parent context.Context, logger *Entry) context.Context
• func SetLevel(level logrus.Level)
• func StartTest(level logrus.Level) func() []*logrus.Entry
• func Warn(args ...interface{})
• func Warnf(format string, args ...interface{})
• type Entry
  • func Ctx(ctx context.Context) *Entry
  • func New() *Entry
  • func WithField(key string, value interface{}) *Entry
  • func WithFields(fields F) *Entry
  • func WithStack(stackProvider interface{}) *Entry
  • func (e *Entry) Debug(args ...interface{})
  • func (e *Entry) Debugf(format string, args ...interface{})
  • func (e *Entry) Error(args ...interface{})
  • func (e *Entry) Errorf(format string, args ...interface{})
  • func (e *Entry) Info(args ...interface{})
  • func (e *Entry) Infof(format string, args ...interface{})
  • func (e *Entry) Panic(args ...interface{})
  • func (e *Entry) Panicf(format string, args ...interface{})
  • func (e *Entry) SetLevel(level logrus.Level)
  • func (e *Entry) StartTest(level logrus.Level) func() []*logrus.Entry
  • func (e *Entry) Warn(args ...interface{})
  • func (e *Entry) Warnf(format string, args ...interface{})
  • func (e *Entry) WithField(key string, value interface{}) *Entry
  • func (e *Entry) WithFields(fields F) *Entry
  • func (e *Entry) WithStack(stackProvider interface{}) *Entry
• type F
• type LogglyHook
  • func NewLogglyHook(token string) *LogglyHook
  • func (hook *LogglyHook) Fire(entry *logrus.Entry) error
  • func (hook *LogglyHook) Flush()
  • func (hook *LogglyHook) Levels() []logrus.Level

Constants

const (
	PanicLevel = logrus.PanicLevel
	ErrorLevel = logrus.ErrorLevel
	WarnLevel  = logrus.WarnLevel
	InfoLevel  = logrus.InfoLevel
	DebugLevel = logrus.DebugLevel
)

Functions

func Debug

func Debug(args ...interface{})

Debug logs a message at the debug severity.

func Debugf

func Debugf(format string, args ...interface{})

Debugf logs a message at the debug severity.

func Error

func Error(args ...interface{})

Error logs a message at the Error severity.

func Errorf

func Errorf(format string, args ...interface{})

Errorf logs a message at the Error severity.

func HTTPMiddleware

func HTTPMiddleware(in http.Handler) http.Handler

HTTPMiddleware is a middleware function that wraps the provided handler in a middleware that logs requests to the default logger.

func Info

func Info(args ...interface{})

Info logs a message at the Info severity.

func Infof

func Infof(format string, args ...interface{})

Infof logs a message at the Info severity.

func Panic

func Panic(args ...interface{})

Panic logs a message at the Panic severity.

func Panicf

func Panicf(format string, args ...interface{})

Panicf logs a message at the Panic severity.

func PushContext

func PushContext(parent context.Context, modFn func(*Entry) *Entry) context.Context

PushContext is a helper method to derive a new context with a modified logger bound to it, where the logger is derived from the current value on the context.

func Set

func Set(parent context.Context, logger *Entry) context.Context

Set establishes a new context to which the provided sub-logger is bound

func SetLevel

func SetLevel(level logrus.Level)

func StartTest

func StartTest(level logrus.Level) func() []*logrus.Entry

StartTest shifts the default logger into "test" mode. See Entry's documentation for the StartTest() method for more info.

func Warn

func Warn(args ...interface{})

Warn logs a message at the Warn severity.

func Warnf

func Warnf(format string, args ...interface{})

Warnf logs a message at the Warn severity.

Types

type Entry

type Entry struct {
	logrus.Entry
	// contains filtered or unexported fields
}

Entry repre

var DefaultLogger *Entry

DefaultLogger represents the default logger that is not bound to any specific context.

func Ctx

func Ctx(ctx context.Context) *Entry

Ctx returns the logger bound to the provided context, otherwise providing the default logger.

func New

func New() *Entry

New creates a new logger, starting at a WARN level and including the current processes pid as a field.

func WithField

func WithField(key string, value interface{}) *Entry

func WithFields

func WithFields(fields F) *Entry

func WithStack

func WithStack(stackProvider interface{}) *Entry

func (*Entry) Debug

func (e *Entry) Debug(args ...interface{})

Debug logs a message at the debug severity.

func (*Entry) Debugf

func (e *Entry) Debugf(format string, args ...interface{})

Debugf logs a message at the debug severity.

func (*Entry) Error

func (e *Entry) Error(args ...interface{})

Error logs a message at the Error severity.

func (*Entry) Errorf

func (e *Entry) Errorf(format string, args ...interface{})

Errorf logs a message at the Error severity.

func (*Entry) Info

func (e *Entry) Info(args ...interface{})

Info logs a message at the Info severity.

func (*Entry) Infof

func (e *Entry) Infof(format string, args ...interface{})

Infof logs a message at the Info severity.

func (*Entry) Panic

func (e *Entry) Panic(args ...interface{})

Panic logs a message at the Panic severity.

func (*Entry) Panicf

func (e *Entry) Panicf(format string, args ...interface{})

Panicf logs a message at the Panic severity.

func (*Entry) SetLevel

func (e *Entry) SetLevel(level logrus.Level)

func (*Entry) StartTest

func (e *Entry) StartTest(level logrus.Level) func() []*logrus.Entry

StartTest shifts this logger into "test" mode, ensuring that log lines will be recorded (rather than outputted). The returned function concludes the test, switches the logger back into normal mode and returns a slice of all raw logrus entries that were created during the test.

func (*Entry) Warn

func (e *Entry) Warn(args ...interface{})

Warn logs a message at the Warn severity.

func (*Entry) Warnf

func (e *Entry) Warnf(format string, args ...interface{})

Warnf logs a message at the Warn severity.

func (*Entry) WithField

func (e *Entry) WithField(key string, value interface{}) *Entry

WithField creates a child logger annotated with the provided key value pair. A subsequent call to one of the logging methods (Debug(), Error(), etc.) to the return value from this function will cause the emitted log line to include the provided value.

func (*Entry) WithFields

func (e *Entry) WithFields(fields F) *Entry

WithFields creates a child logger annotated with the provided key value pairs.

func (*Entry) WithStack

func (e *Entry) WithStack(stackProvider interface{}) *Entry

WithStack annotates this error with a stack trace from `stackProvider`, if available. normally `stackProvider` would be an error that implements `errors.StackTracer`.

type F

type F logrus.Fields

F wraps the logrus.Fields type for the convenience of typing less.

type LogglyHook

type LogglyHook struct {
	FilteredKeys map[string]bool
	// contains filtered or unexported fields
}

LogglyHook sends logs to loggly

func NewLogglyHook

func NewLogglyHook(token string) *LogglyHook

NewLogglyHook creates a new hook

func (*LogglyHook) Fire

func (hook *LogglyHook) Fire(entry *logrus.Entry) error

func (*LogglyHook) Flush

func (hook *LogglyHook) Flush()

func (*LogglyHook) Levels

func (hook *LogglyHook) Levels() []logrus.Level