logging

Documentation

Overview

Package logging defines the minimal interface that loggers must support to be used by pack.

Index

• func GetDebugErrorWriter(l Logger) io.Writer
• func GetDebugWriter(l Logger) io.Writer
• func New(w io.Writer) *defaultLogger
• func Tip(l Logger, format string, v ...interface{})
• type Logger
• type PrefixWriter
  • func NewPrefixWriter(w io.Writer, prefix string) *PrefixWriter
  • func (w *PrefixWriter) Write(buf []byte) (int, error)
• type WithDebugErrorWriter
• type WithDebugWriter

Functions

func GetDebugErrorWriter

func GetDebugErrorWriter(l Logger) io.Writer

GetDebugErrorWriter will return an ErrorWriter, typically stderr if one exists, otherwise the standard logger writer will be returned.

func GetDebugWriter

func GetDebugWriter(l Logger) io.Writer

GetDebugWriter returns a writer See WithDebugWriter

func New

func New(w io.Writer) *defaultLogger

New creates a default logger for the pack library. Note that the pack CLI has it's own logger.

func Tip

func Tip(l Logger, format string, v ...interface{})

Tip logs a tip.

Types

type Logger

type Logger interface {
	Debug(msg string)
	Debugf(fmt string, v ...interface{})

	Info(msg string)
	Infof(fmt string, v ...interface{})

	Warn(msg string)
	Warnf(fmt string, v ...interface{})

	Error(msg string)
	Errorf(fmt string, v ...interface{})

	Writer() io.Writer
}

Logger defines behavior required by a logging package used by pack libraries

type PrefixWriter

type PrefixWriter struct {
	// contains filtered or unexported fields
}

PrefixWriter will prefix writes

func NewPrefixWriter

func NewPrefixWriter(w io.Writer, prefix string) *PrefixWriter

NewPrefixWriter writes by w will be prefixed

func (*PrefixWriter) Write

func (w *PrefixWriter) Write(buf []byte) (int, error)

Writes bytes to the embedded log function

type WithDebugErrorWriter

type WithDebugErrorWriter interface {
	DebugErrorWriter() io.Writer
}

WithDebugErrorWriter is an optional interface for loggers that want to support a separate writer for errors and standard logging. the DebugErrorWriter should write to stderr if quiet is false.

type WithDebugWriter

type WithDebugWriter interface {
	DebugWriter() io.Writer
}

WithDebugWriter is an optional interface what will return a writer that will write raw output if quiet is false.