log

Documentation

Index

• Variables
• type Formatter
• type Writer
  • func New(options ...func(w *Writer)) Writer
  • func (w Writer) Write(p []byte) (n int, err error)

Variables

var (
	HostFieldName = "host"
	ModFieldName  = "mod"
)

Types

type Formatter

type Formatter func(interface{}) string

Formatter transforms the input into a formatted string.

type Writer

type Writer struct {
	// Out is the output destination.
	Out io.Writer

	// NoColor disables the colorized output.
	NoColor bool

	// TimeFormat specifies the format for timestamp in output.
	TimeFormat string

	// PartsOrder defines the order of parts in output.
	PartsOrder []string

	FormatTimestamp     Formatter
	FormatLevel         Formatter
	FormatCaller        Formatter
	FormatMessage       Formatter
	FormatFieldName     Formatter
	FormatFieldValue    Formatter
	FormatErrFieldName  Formatter
	FormatErrFieldValue Formatter
}

Writer parses the JSON input and writes it in an (optionally) colorized, human-friendly format to Out.

func New

func New(options ...func(w *Writer)) Writer

New creates and initializes a new Writer.

func (Writer) Write

func (w Writer) Write(p []byte) (n int, err error)

Write transforms the JSON input with formatters and appends to w.Out.