format

Documentation

Overview

Package format implements a custom format logs

Index

• Constants
• func NewBareFormatPlaceholders() Placeholders
• func NewJSONFormatPlaceholders() Placeholders
• func NewKeyValueFormatPlaceholders() Placeholders
• func NewPrettyFormatPlaceholders() Placeholders
• func ParseFormat(str string) (Placeholders, error)
• type Formatter
  • func NewFormatter(phs placeholders.Placeholders) *Formatter
  • func (formatter *Formatter) DisableRelativePaths()
  • func (formatter *Formatter) DisabledColors() bool
  • func (formatter *Formatter) DisabledOutput() bool
  • func (formatter *Formatter) Format(entry *log.Entry) ([]byte, error)
  • func (formatter *Formatter) SetBaseDir(baseDir string) error
  • func (formatter *Formatter) SetCustomFormat(str string) error
  • func (formatter *Formatter) SetDisabledColors(val bool)
  • func (formatter *Formatter) SetDisabledOutput(val bool)
  • func (formatter *Formatter) SetFormat(str string) error

Constants

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

Functions

func NewBareFormatPlaceholders

func NewBareFormatPlaceholders() Placeholders

func NewJSONFormatPlaceholders

func NewJSONFormatPlaceholders() Placeholders

func NewKeyValueFormatPlaceholders

func NewKeyValueFormatPlaceholders() Placeholders

func NewPrettyFormatPlaceholders

func NewPrettyFormatPlaceholders() 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) DisableRelativePaths

func (formatter *Formatter) DisableRelativePaths()

DisableRelativePaths disables the conversion of absolute paths to relative ones.

func (*Formatter) DisabledColors

func (formatter *Formatter) DisabledColors() bool

DisabledColors returns true if log colors are disabled.

func (*Formatter) DisabledOutput

func (formatter *Formatter) DisabledOutput() bool

DisabledOutput returns true if log output is disabled.

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

SetBaseDir creates a set of relative paths that are used to convert full paths to relative ones.

func (*Formatter) SetCustomFormat

func (formatter *Formatter) SetCustomFormat(str string) error

SetCustomFormat parses and sets custom log format.

func (*Formatter) SetDisabledColors

func (formatter *Formatter) SetDisabledColors(val bool)

SetDisabledColors enables/disables log colors.

func (*Formatter) SetDisabledOutput

func (formatter *Formatter) SetDisabledOutput(val bool)

SetDisabledOutput enables/disables log output.

func (*Formatter) SetFormat

func (formatter *Formatter) SetFormat(str string) error

SetFormat parses and sets log format.