formatter

Documentation

Index

• type CLI
  • func NewCLI(noUseColors bool) *CLI
  • func (c *CLI) Format(event *LogEvent) ([]byte, error)
• type Formatter
• type JSON
  • func (j *JSON) Format(event *LogEvent) ([]byte, error)
• type LogEvent
• type Tee
  • func NewTee(wrapper Formatter, w io.Writer) (teeW *Tee)
  • func (tee *Tee) Format(event *LogEvent) (bts []byte, err error)

Types

type CLI

type CLI struct {
	NoUseColors bool
	// contains filtered or unexported fields
}

CLI is a formatter for outputting CLI logs

func NewCLI

func NewCLI(noUseColors bool) *CLI

NewCLI returns a new CLI based formatter

func (*CLI) Format

func (c *CLI) Format(event *LogEvent) ([]byte, error)

Format formats the log event data into bytes

type Formatter

type Formatter interface {
	// Format formats the log event data into bytes
	Format(event *LogEvent) ([]byte, error)
}

Formatter type format raw logging data into something useful

type JSON

type JSON struct{}

JSON is a formatter for outputting json logs

func (*JSON) Format

func (j *JSON) Format(event *LogEvent) ([]byte, error)

Format formats the log event data into bytes

type LogEvent

type LogEvent struct {
	Message      string
	Level        levels.Level
	Metadata     map[string]string
	KeyValuePair []types.KeyValuePair
}

LogEvent is the respresentation of a single event to be logged.

type Tee

type Tee struct {
	Wrapper Formatter

	Formatter Formatter
	// contains filtered or unexported fields
}

Tee formatter can be used to write the event to a writer while also use the existing formatter and output

func NewTee

func NewTee(wrapper Formatter, w io.Writer) (teeW *Tee)

NewTee returns a new TeeWriter with default JSON messages

func (*Tee) Format

func (tee *Tee) Format(event *LogEvent) (bts []byte, err error)

Format saves the event and forwards the event to the internal Wrapper