logentryformatter

Documentation

Index

• func DescribeObject(obj interface{}) string
• func FormatLogLine(text string, unwrapperMap map[LogType]Unwrapper, ...) (string, error)
• func FormatValue(val interface{}) string
• func NiceMap(params map[string]interface{}) string
• type ColorizerFunc
• type Formatter
  • func New(entryParser func([]byte, bool) (interface{}, error), tmplString string, ...) (Formatter, error)
• type LogEntry
• type LogType
• type Param
  • func Colorizer(c ColorizerFunc) Param
  • func NoSubstitution() Param
  • func ObjDesc(objDesc string) Param
• type Unwrapper
• type UnwrapperFunc
  • func (f UnwrapperFunc) UnwrapLogLine(lineJSON []byte) ([]byte, error)

Functions

func DescribeObject

func DescribeObject(obj interface{}) string

func FormatLogLine

func FormatLogLine(text string, unwrapperMap map[LogType]Unwrapper, formatterMap map[LogType]Formatter, only, exclude map[LogType]struct{}) (string, error)

func FormatValue

func FormatValue(val interface{}) string

func NiceMap

func NiceMap(params map[string]interface{}) string

Types

type ColorizerFunc

type ColorizerFunc func(interface{}) *color.Color

type Formatter

type Formatter interface {
	// Format takes JSON bytes that represents a single log entry and returns the human-readable version.
	Format(lineJSON []byte) (string, error)
	// RawTemplate returns the raw template string for this formatter.
	RawTemplate() string
	// TemplateObjectDescription returns the description of the object that is expected to be provided to the
	// template function for this formatter. Empty string indicates that there is no suitable description.
	TemplateObjectDescription() string
}

func New

func New(entryParser func([]byte, bool) (interface{}, error), tmplString string, params ...Param) (Formatter, error)

type LogEntry

type LogEntry struct {
	Type *LogType `json:"type"`
}

type LogType

type LogType string

type Param

type Param interface {
	// contains filtered or unexported methods
}

func Colorizer

func Colorizer(c ColorizerFunc) Param

func NoSubstitution

func NoSubstitution() Param

NoSubstitution configures the formatter in a mode that specifies that no substitution should be performed.

func ObjDesc

func ObjDesc(objDesc string) Param

type Unwrapper

type Unwrapper interface {
	UnwrapLogLine(lineJSON []byte) ([]byte, error)
}

An Unwrapper unwraps a line of JSON, returning the underlying log entry's contents.

type UnwrapperFunc

type UnwrapperFunc func([]byte) ([]byte, error)

The UnwrapperFunc type is an adapter to allow the use of ordinary functions as Unwrappers. If f is a function with the appropriate signature, UnwrapperFunc(f) is an Unwrapper that calls f.

func (UnwrapperFunc) UnwrapLogLine

func (f UnwrapperFunc) UnwrapLogLine(lineJSON []byte) ([]byte, error)

UnwrapLogLine calls f(lineJSON).