logger

Documentation

Overview

Package logger provides an abstract representation of logging interfaces used by recovery lib.

Index

• type LogIndenter
• type Logger
  • func NewLogger() Logger
• type StepLogCloser
• type StepLogRegister

Types

type LogIndenter

type LogIndenter interface {
	// Indent increment indentation for logger.
	Indent()
	// Dedent decrement indentation for logger.
	Dedent()
}

LogIndenter represents a simple interface to provide option to set indent logs. Interface mostly used for local debugging and testing.

type Logger

type Logger interface {
	// Debugf log message at Debugf level.
	Debugf(format string, args ...interface{})
	// Infof is like Debug, but logs at Infof level.
	Infof(format string, args ...interface{})
	// Warningf is like Debug, but logs at Warningf level.
	Warningf(format string, args ...interface{})
	// Errorf is like Debug, but logs at Errorf level.
	Errorf(format string, args ...interface{})
}

Logger represents a simple interface for logging data.

func NewLogger

func NewLogger() Logger

NewLogger creates default logger.

type StepLogCloser

type StepLogCloser func()

StepLogCloser represents a simple function to unregister/close step's log in the logger.

type StepLogRegister

type StepLogRegister interface {
	// RegisterStepLog add step's io.Writer as new logger.
	RegisterStepLog(ctx context.Context, wr io.Writer) (StepLogCloser, error)
}

StepLogRegister represents a simple interface to provide option to add step's log to the logger.