bundles

Documentation

Index

• Constants
• type Config
  • func GetConfig(opts ...Option) Config
• type LogFormat
• type Option
• type OptionLogFormat
• type OptionLoggerReportCaller
• type OptionTimestampFormat
• type OptionTracer
• type OptionTracerReportCaller

Constants

const (
	// LogFormatPlainText means to write logs as a plain text.
	LogFormatPlainText = LogFormat(iota)

	// LogFormatPlainTextCompact means to write logs as a compact plain text.
	//
	// Falls back to LogFormatPlainText if the compact format is not supported.
	LogFormatPlainTextCompact

	// LogFormatJSON means to write logs as JSON objects.
	LogFormatJSON
)

Types

type Config

type Config struct {
	LoggerReportCaller bool
	TracerReportCaller bool
	TimestampFormat    string
	VerboseCaller      bool
	Tracer             xcontext.Tracer
	Format             LogFormat
}

Config is a configuration state resulted from Option-s.

func GetConfig

func GetConfig(opts ...Option) Config

GetConfig processes passed Option-s and returns the resulting state as Config.

type LogFormat

type LogFormat int

LogFormat is a selector of an output format.

type Option

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

Option is a modifier of what context to construct.

type OptionLogFormat

type OptionLogFormat LogFormat

OptionLogFormat defines the format for logs.

type OptionLoggerReportCaller

type OptionLoggerReportCaller bool

OptionLoggerReportCaller defines if it is required to determine source-code file name and line and report it to logs. It negatively affects performance of logging.

type OptionTimestampFormat

type OptionTimestampFormat string

OptionTimestampFormat defines the format of timestamps while logging.

type OptionTracer

type OptionTracer struct {
	xcontext.Tracer
}

OptionTracer defines if a tracer should be added to the context.

type OptionTracerReportCaller

type OptionTracerReportCaller bool

OptionTracerReportCaller the same as OptionLoggerReportCaller, but for a tracer.