logutil

Documentation

Overview

Package logutil is a utility package for github.com/sirupsen/logrus.

Index

• Constants
• func NewLogger(opts ...Option) (*logrus.Entry, error)
• func NoopEntry() *logrus.Entry
• func NoopLogger() *logrus.Logger
• func WithComponent(e *logrus.Entry, component string) *logrus.Entry
• func WithMethod(e *logrus.Entry, v zero.Interface) *logrus.Entry
• func WithSource(e *logrus.Entry, v zero.Interface) *logrus.Entry
• type Config
• type Format
  • func ParseFormat(fmt string) (Format, error)
  • func (fmt Format) String() string
  • func (fmt *Format) UnmarshalMap(v zero.Interface) (err error)
• type Option
  • func WithCaller(enable bool) Option
  • func WithFormat(fmt Format) Option
  • func WithLevel(lvl logrus.Level) Option
  • func WithLevelString(lvl string) Option
  • func WithOutput(output io.Writer) Option
  • func WithSentry(client *raven.Client) Option

Examples

• NoopEntry
• WithMethod

Constants

const (
	// SourceKey is the field key used to store the type name of the logging
	// source.
	SourceKey = "source"

	// MethodKey is the field key used to store the method name where the logger
	// is being called.
	MethodKey = "method"

	// ComponentKey is the field key used to store the logging object's component
	// path.
	ComponentKey = "component"
)

Functions

func NewLogger

func NewLogger(opts ...Option) (*logrus.Entry, error)

NewLogger creates an application-level logrus.Entry.

func NoopEntry

func NoopEntry() *logrus.Entry

NoopEntry returns a no-op logrus.NoopEntry.

Example

package main

import (
	"os"

	"github.com/sirupsen/logrus"
	"go.stevenxie.me/gopkg/logutil"
)

var _logrusFormatter = &logrus.TextFormatter{DisableTimestamp: true}

func main() {
	// Regular logger will produce output.
	log := logrus.New()
	log.SetOutput(os.Stdout)
	log.SetFormatter(_logrusFormatter)
	log.WithField("kind", "default").Info("Oh-ho, who's this?")

	// No-op logger will not produce output.
	noopLog := logutil.NoopLogger()
	noopLog.SetFormatter(_logrusFormatter)
	noopLog.WithField("kind", "noop").Info("Hey, it's a-me.")

}

Output:

level=info msg="Oh-ho, who's this?" kind=default

func NoopLogger

func NoopLogger() *logrus.Logger

NoopLogger returns a no-op logrus.NoopLogger.

func WithComponent

func WithComponent(e *logrus.Entry, component string) *logrus.Entry

WithComponent appends the component to the component path field of the logrus.Entry.

func WithMethod

func WithMethod(e *logrus.Entry, v zero.Interface) *logrus.Entry

WithMethod adds the name of the method v to the logrus.Entry.

Example

l := logrus.New()
l.SetOutput(os.Stdout)
l.SetFormatter(_logrusFormatter)

ss := SomeStruct{log: logrus.NewEntry(l)}
ss.LogWithMethod()

Output:

level=info msg="Hello from method!" method=LogWithMethod

func WithSource

func WithSource(e *logrus.Entry, v zero.Interface) *logrus.Entry

WithSource adds the type name of v to a logrus.Entry.

Types

type Config

type Config struct {
	// Logging options.
	Level        logrus.Level
	ReportCaller bool

	// Output options.
	Output        io.Writer
	Format        Format
	TextFormatter logrus.TextFormatter
	JSONFormatter logrus.JSONFormatter

	// Extension options.
	Raven *raven.Client
}

A Config configures a logrus.Logger.

type Format

type Format uint8

A Format represents an output formatting type for Logrus.

const (
	UnknownFormat Format = iota
	JSONFormat
	TextFormat
)

The set of logrus formats.

func ParseFormat

func ParseFormat(fmt string) (Format, error)

ParseFormat parses a Format from the string fmt.

func (Format) String

func (fmt Format) String() string

func (*Format) UnmarshalMap

func (fmt *Format) UnmarshalMap(v zero.Interface) (err error)

UnmarshalMap unmarshals fmt from a mapstructure.

type Option

type Option func(*Config)

A Option modifies a LogrusConfig.

func WithCaller

func WithCaller(enable bool) Option

WithCaller configures a logrus.Logger to report callers.

func WithFormat

func WithFormat(fmt Format) Option

WithFormat configures the output format of a logrus.Logger.

func WithLevel

func WithLevel(lvl logrus.Level) Option

WithLevel configures a logrus.Logger to log at lvl.

func WithLevelString

func WithLevelString(lvl string) Option

WithLevelString is like LogrusWithLevel, but parses the level from lvl.

It panics if lvl is an invalid logrus.Level.

func WithOutput

func WithOutput(output io.Writer) Option

WithOutput configures a logrus.Logger to write to output.

func WithSentry

func WithSentry(client *raven.Client) Option

WithSentry adds a Sentry reporting hook to a logrus.Logger.