svclog

Documentation

Overview

Package svclog provides logging facilities for standard services.

Index

• func LoggerOrNull(l logrus.FieldLogger) logrus.FieldLogger
• func NewLogger(cfg Config) logrus.FieldLogger
• func NewNullLogger() logrus.FieldLogger
• func NewSampleLogger(parentLogger logrus.FieldLogger, logsBurstLimit int, ...) logrus.FieldLogger
• func SaramaLogger(logger logrus.FieldLogger) logrus.FieldLogger
• type Config

Functions

func LoggerOrNull

func LoggerOrNull(l logrus.FieldLogger) logrus.FieldLogger

LoggerOrNull ensures non-nil logger is passed in or creates a Null Logger

func NewLogger

func NewLogger(cfg Config) logrus.FieldLogger

NewLogger returns a new logger that includes app and deploy key/value pairs in each log line.

func NewNullLogger

func NewNullLogger() logrus.FieldLogger

NewNullLogger returns a logger that discards the output useful for testing

func NewSampleLogger

func NewSampleLogger(parentLogger logrus.FieldLogger, logsBurstLimit int, logBurstWindow time.Duration) logrus.FieldLogger

NewSampleLogger creates a rate limited logger that samples logs. The parameter logsBurstLimit defines how many logs are allowed per logBurstWindow duration. The returned logger derives from the parentLogger, but without inheriting any Hooks. All log entries derived from SampleLogger will contain 'sampled=true' field.

func SaramaLogger

func SaramaLogger(logger logrus.FieldLogger) logrus.FieldLogger

SaramaLogger takes FieldLogger and returns a saramaLogger.

Types

type Config

type Config struct {
	AppName  string `env:"APP_NAME,required"`
	Deploy   string `env:"DEPLOY,required"`
	SpaceID  string `env:"SPACE_ID"`
	Dyno     string `env:"DYNO"`
	LogLevel string `env:"LOG_LEVEL,default=info"`
}

Config for logger.