format

Documentation

Overview

Package format implements a custom format logs

Index

• Constants
• func NewBareFormat() Placeholders
• func NewJSONFormat() Placeholders
• func NewKeyValueFormat() Placeholders
• func NewPrettyFormat() Placeholders
• func ParseFormat(str string) (Placeholders, error)
• type Formatter
  • func NewFormatter(phs placeholders.Placeholders) *Formatter
  • func (formatter *Formatter) DisableColors()
  • func (formatter *Formatter) DisableRelativePaths()
  • func (formatter *Formatter) Format(entry *log.Entry) ([]byte, error)
  • func (formatter *Formatter) SetBaseDir(baseDir string) error
  • func (formatter *Formatter) SetFormat(phs placeholders.Placeholders)

Constants

const (
	BareFormatName     = "bare"
	PrettyFormatName   = "pretty"
	JSONFormatName     = "json"
	KeyValueFormatName = "key-value"
)

Functions

func NewBareFormat

func NewBareFormat() Placeholders

func NewJSONFormat

func NewJSONFormat() Placeholders

func NewKeyValueFormat

func NewKeyValueFormat() Placeholders

func NewPrettyFormat

func NewPrettyFormat() Placeholders

func ParseFormat

func ParseFormat(str string) (Placeholders, error)

Types

type Formatter

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

func NewFormatter

func NewFormatter(phs placeholders.Placeholders) *Formatter

NewFormatter returns a new Formatter instance with default values.

func (*Formatter) DisableColors

func (formatter *Formatter) DisableColors()

DisableColors disables log color.

func (*Formatter) DisableRelativePaths

func (formatter *Formatter) DisableRelativePaths()

DisableRelativePaths disables the conversion of absolute paths to relative ones.

func (*Formatter) Format

func (formatter *Formatter) Format(entry *log.Entry) ([]byte, error)

Format implements logrus.Format.

func (*Formatter) SetBaseDir

func (formatter *Formatter) SetBaseDir(baseDir string) error

func (*Formatter) SetFormat

func (formatter *Formatter) SetFormat(phs placeholders.Placeholders)

SetFormat sets log format.