core

Documentation

Index

• type Fields
• type Level
  • func (l Level) CapitalString() string
  • func (l Level) Enabled(lvl Level) bool
  • func (l *Level) Get() any
  • func (l Level) MarshalText() ([]byte, error)
  • func (l *Level) Set(s string) error
  • func (l Level) String() string
  • func (l *Level) UnmarshalText(text []byte) error
• type Mode
• type Record
• type SinkType
  • func GetSinkType(sink string) (SinkType, error)

Types

type Fields

type Fields map[string]any

Fields represents attached fields of log

type Level

type Level int8

A Level is a logging priority. Higher levels are more important.

const (
	// DebugLevel logs are typically voluminous, and are usually disabled in
	// production.
	DebugLevel Level = iota - 1
	// InfoLevel is the default logging priority.
	InfoLevel
	// WarnLevel logs are more important than Info, but don't need individual
	// human review.
	WarnLevel
	// ErrorLevel logs are high-priority. If an application is running smoothly,
	// it shouldn't generate any error-level logs.
	ErrorLevel
	// DPanicLevel logs are particularly important errors. In development the
	// logger panics after writing the message.
	DPanicLevel
	// PanicLevel logs a message, then panics.
	PanicLevel
	// FatalLevel logs a message, then calls os.Exit(1).
	FatalLevel
)

func (Level) CapitalString

func (l Level) CapitalString() string

CapitalString returns an all-caps ASCII representation of the log level.

func (Level) Enabled

func (l Level) Enabled(lvl Level) bool

Enabled returns true if the given level is at or above this level.

func (*Level) Get

func (l *Level) Get() any

Get gets the level for the flag.Getter interface.

func (Level) MarshalText

func (l Level) MarshalText() ([]byte, error)

MarshalText marshals the Level to text. Note that the text representation drops the -Level suffix (see example).

func (*Level) Set

func (l *Level) Set(s string) error

Set sets the level for the flag.Value interface.

func (Level) String

func (l Level) String() string

String returns a lower-case ASCII representation of the log level.

func (*Level) UnmarshalText

func (l *Level) UnmarshalText(text []byte) error

UnmarshalText unmarshals text to a level. Like MarshalText, UnmarshalText expects the text representation of a Level to drop the -Level suffix (see example).

In particular, this makes it easy to configure logging levels using YAML, TOML, or JSON files.

type Mode

type Mode string

const (
	ModeSimple Mode = "SIMPLE"
	ModeFull   Mode = "FULL"
)

type Record

type Record struct {
	Level Level

	Format *string
	Args   []any

	KVs       []any  // additional custom variadic key-value pairs
	CxtFields Fields // caller's goroutine context fields
}

Record represent an log, contains all properties.

type SinkType

type SinkType int

const (
	SinkConsole SinkType = iota // default
	SinkFile
	SinkMulti
)

func GetSinkType

func GetSinkType(sink string) (SinkType, error)