logging

Documentation

Index

• Constants
• Variables
• func Set(setter Setter) error
• type Logger
  • func New(component string, setters ...Setter) Logger
• type Setter
  • func Level(lvl string) Setter
• type SubLogger

Constants

const (
	SubComponentField = "subcomponent"
	ComponentField    = "component"
)

Variables

var DebugEnable string

DebugEnable is a string passed in by the compiler to control the build's inclusion of Debuggable sections.

var Debuggable = DebugEnable == "true"

Debuggable means that the build should include any debugging logic in it. The compiler *should* erase anything that's otherwise in a conditional.

Functions

func Set

func Set(setter Setter) error

Set mutates the underlying root logging implementation.

Types

type Logger

type Logger interface {
	logrus.FieldLogger

	Writer() *io.PipeWriter
	WriterLevel(logrus.Level) *io.PipeWriter
}

Logger is a top level component logging facade.

func New

func New(component string, setters ...Setter) Logger

New creates a top level Logger for a given component.

type Setter

type Setter func(*logrus.Logger) error

func Level

func Level(lvl string) Setter

Level sets the level of the root logger.

type SubLogger

type SubLogger interface {
	logrus.FieldLogger
}

SubLogger is a sub component logging facade for subsystems that do not have their own top level logging owner.