text

Documentation

Overview

Package text implements a text formatter which implements the Formatter.

Index

• Constants
• type Color
• type Config
  • func NewConfig() Config
• type Formatter
  • func New(config Config) *Formatter
  • func (formatter *Formatter) Color(level iface.Level) Color
  • func (formatter *Formatter) Coloring() bool
  • func (formatter *Formatter) DisableColoring()
  • func (formatter *Formatter) EnableColoring()
  • func (formatter *Formatter) Format(record *iface.Record) []byte
  • func (formatter *Formatter) Header() string
  • func (formatter *Formatter) MapColors(colorMap map[iface.Level]Color)
  • func (formatter *Formatter) MarkedColor() Color
  • func (formatter *Formatter) MinBufSize() int
  • func (formatter *Formatter) SetColor(level iface.Level, color Color)
  • func (formatter *Formatter) SetHeader(header string)
  • func (formatter *Formatter) SetMarkedColor(color Color)
  • func (formatter *Formatter) SetMinBufSize(size int)

Constants

const (
	FullHeader = "{{time}} {{level}} {{file}}:{{line}} {{pkg}}.{{func}} " +
		"{{prefix}}[{{context}}] {{msg}}\n"
	CompactHeader = "{{time:time.us}} {{level}} {{file:1}}:{{line}} " +
		"{{pkg}}.{{func}} {{prefix}}[{{context}}] {{msg}}\n"
	SyslogHeader = "{{file:1}}:{{line}} {{pkg}}.{{func}} {{prefix}}" +
		"[{{context}}] {{msg}}\n"
)

All predefined headers here.

Types

type Color

type Color int

The Color defines the color type.

const (
	Black Color = iota + 30
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	White
)

Basic colors here.

const (
	BrightBlack Color = iota + 90
	BrightRed
	BrightGreen
	BrightYellow
	BrightBlue
	BrightMagenta
	BrightCyan
	BrightWhite
)

Bright colors here.

type Config

type Config struct {
	// Header is the format specifier of a text formatter.
	// It is used to specify which and how the fields of a Record to be formatted.
	// The pattern of a field specifier is {{<name>[:property][%fmtstr]}}.
	// e.g. {{level:char}}, {{line%05d}}, {{pkg:1}}, {{context:list%40s}}
	// All fields have support for the fmtstr. If the fmtstr is NOT the default
	// one of a field, it will be passed to fmt.Sprintf to format the field and
	// this affects the performance a little.
	// The supported properties vary with fields.
	// All supported fields are as the follows:
	//   name    | supported property       | defaults     | property examples
	// ----------+--------------------------+--------------+------------------------
	//   time    | <date|time>[.ms|.us|.ns] | "date.us" %s | "date.ns", "time"
	//           | layout that is supported |              | time.RFC3339Nano
	//           |   by the time package    |              | "02 Jan 06 15:04 -0700"
	//   level   | <full|char>              | "full"    %s | "full", "char"
	//   file    | <lastSegs>               | 0         %s | 0, 1, 2, ...
	//   line    |                          |           %d |
	//   pkg     | <lastSegs>               | 0         %s | 0, 1, 2, ...
	//   func    | <lastSegs>               | 0         %s | 0, 1, 2, ...
	//   prefix  |                          |           %s |
	//   context | <pair|list>              | "pair"    %s | "pair", "list"
	//   msg     |                          |           %s |
	// If Header is not specified, FullHeader is used.
	Header string
	// MinBufSize is the initial size of the internal buf of a formatter.
	// MinBufSize must NOT be negative. If it is not specified, 256 is used.
	MinBufSize int
	// ColorMap is used to remap the color of each level.
	// By default, the color of Trace, Debug and Info is Green, the color of Warn
	// is Yellow, the color of Error and Fatal is Red. The color of a marked log
	// is Magenta despite of its level.
	// The color of a level is left to be unchanged if it is not in the map.
	ColorMap map[iface.Level]Color
	// Coloring specifies whether colorization is enabled.
	Coloring bool
}

A Config is used to configure a text formatter.

func NewConfig

func NewConfig() Config

type Formatter

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

A Formatter implements the interface iface.Formatter.

All methods of a Formatter are concurrency safe. A Formatter MUST be created with New.

func New

func New(config Config) *Formatter

New creates a new Formatter with the config.

func (*Formatter) Color

func (formatter *Formatter) Color(level iface.Level) Color

Color returns the color of the level in the Formatter.

func (*Formatter) Coloring

func (formatter *Formatter) Coloring() bool

Coloring returns whether colorization is enabled in the Formatter.

func (*Formatter) DisableColoring

func (formatter *Formatter) DisableColoring()

DisableColoring disables colorization in the Formatter.

func (*Formatter) EnableColoring

func (formatter *Formatter) EnableColoring()

EnableColoring enables colorization in the Formatter.

func (*Formatter) Format

func (formatter *Formatter) Format(record *iface.Record) []byte

Format implements the interface Formatter. It formats a Record.

func (*Formatter) Header

func (formatter *Formatter) Header() string

Header returns the header of the Formatter.

func (*Formatter) MapColors

func (formatter *Formatter) MapColors(colorMap map[iface.Level]Color)

MapColors maps the color of levels in the Formatter according to the colorMap. The color of a level is left to be unchanged if it is not in the map.

func (*Formatter) MarkedColor

func (formatter *Formatter) MarkedColor() Color

MarkedColor returns the color of a log that is marked.

func (*Formatter) MinBufSize

func (formatter *Formatter) MinBufSize() int

MinBufSize returns the min buf size of the Formatter.

func (*Formatter) SetColor

func (formatter *Formatter) SetColor(level iface.Level, color Color)

SetColor sets the color of the level in the Formatter.

func (*Formatter) SetHeader

func (formatter *Formatter) SetHeader(header string)

SetHeader sets the header of the Formatter. For details of all supported fields in a header, see the comment of Config.

func (*Formatter) SetMarkedColor

func (formatter *Formatter) SetMarkedColor(color Color)

SetMarkedColor sets the color of a log that is marked.

func (*Formatter) SetMinBufSize

func (formatter *Formatter) SetMinBufSize(size int)

SetMinBufSize sets the min buf size of the Formatter. The size must NOT be negative. If the size is 0, 256 is used.