log

Documentation

Overview

Package log configuration

Index

• Constants
• func ContextWithLogger(ctx context.Context, logger Logger) context.Context
• func NewLogger(level Level, format Format) *logrus.Logger
• func NewLoggerFromConfig(config Config) *logrus.Logger
• func WithLoggerFields(ctx context.Context, fields logrus.Fields) context.Context
• type Config
  • func DefaultConfig() Config
  • func (config *Config) BindFlags() []cli.Flag
• type Duration
  • func (duration Duration) String() string
• type Format
  • func AvailableFormats() []Format
  • func (format *Format) Set(value string) error
  • func (format Format) String() string
• type Level
  • func AvailableLevels() []Level
  • func (ll *Level) Set(s string) error
  • func (ll Level) String() string
• type Logger
  • func LoggerFromContext(ctx context.Context, loggerName string) Logger
• type UnknownFormatError
  • func NewUnknownFormatError(value string) *UnknownFormatError
  • func (err *UnknownFormatError) Error() string

Constants

const (
	LoggerField = "logger"

	FieldStack = "stack"

	FieldTemplateLoader  = "template_loader"
	FieldTemplateName    = "template_name"
	FieldTemplatePart    = "template_part"
	FieldTemplateType    = "template_type"
	FieldTemplateDir     = "template_dir"
	FieldTemplatePath    = "template_path"
	FieldCallbackType    = "event_type"
	FieldTemplateExample = "template_example"

	FieldDocumentID  = "document_id"
	FieldContentType = "content_type"
	FieldAssetPath   = "asset_path"

	FieldListenAddr  = "listen_addr"
	FieldDocumentURL = "document_url"

	FieldBrowserReply = "browser_reply"
	FieldBrowserEvent = "browser_event"
	FieldBrowserOut   = "browser_out"
	FieldBrowserState = "browser_state"
	FieldBrowserData  = "browser_data"

	FieldRenderDataErrors = "render_data_errors"
	FieldRenderData       = "render_data"

	FieldConfig = "config"

	FieldDuration = "duration"

	FieldRequestID     = "request_id"
	FieldRequestIP     = "addr"
	FieldRequestMethod = "method"
	FieldRequestPath   = "path"
	FieldRequestRoute  = "route"
	FieldRequestQuery  = "query"

	FieldResponseCode = "response_code"
	FieldResponseSize = "response_size"
)

Logger fields.

const (
	LevelTrace = Level(logrus.TraceLevel)
	LevelDebug = Level(logrus.DebugLevel)
	LevelInfo  = Level(logrus.InfoLevel)
	LevelWarn  = Level(logrus.WarnLevel)
	LevelError = Level(logrus.ErrorLevel)
	LevelFatal = Level(logrus.FatalLevel)
)

Logger levels.

const (
	TextFormat = Format("text")
	JSONFormat = Format("json")
)

Definition of available log formats.

const (
	ContextKeyRequestID = contextKey("requestID")
)

Context keys.

Functions

func ContextWithLogger

func ContextWithLogger(ctx context.Context, logger Logger) context.Context

ContextWithLogger create new context with logger.

func NewLogger

func NewLogger(level Level, format Format) *logrus.Logger

NewLogger with selected level.

func NewLoggerFromConfig

func NewLoggerFromConfig(config Config) *logrus.Logger

NewLoggerFromConfig constructor.

func WithLoggerFields

func WithLoggerFields(ctx context.Context, fields logrus.Fields) context.Context

WithLoggerFields create new context with logger with fields.

Types

type Config

type Config struct {
	Level  Level
	Format Format
}

Config defines the configuration of the logger.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default config.

func (*Config) BindFlags

func (config *Config) BindFlags() []cli.Flag

BindFlags binds the flags to the config.

type Duration

type Duration time.Duration

Duration used to wrap time.Duration value to log only seconds.

func (Duration) String

func (duration Duration) String() string

String return test representation of Duration for logging value.

type Format

type Format string

Format text or json.

func AvailableFormats

func AvailableFormats() []Format

AvailableFormats return list all available log formats.

func (*Format) Set

func (format *Format) Set(value string) error

Set parse log format value on parsing cli arguments.

func (Format) String

func (format Format) String() string

type Level

type Level logrus.Level

Level is logrus.Level wrapper with support flag.Value interface.

func AvailableLevels

func AvailableLevels() []Level

AvailableLevels return all available log levels.

func (*Level) Set

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

Set implement flag.Value.Set interface.

func (Level) String

func (ll Level) String() string

type Logger

type Logger logrus.FieldLogger

Logger interface.

func LoggerFromContext

func LoggerFromContext(ctx context.Context, loggerName string) Logger

LoggerFromContext fetch logger from context.

type UnknownFormatError

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

UnknownFormatError return by LogFormat.Set when provided unknown format.

func NewUnknownFormatError

func NewUnknownFormatError(value string) *UnknownFormatError

NewUnknownFormatError constructor.

func (*UnknownFormatError) Error

func (err *UnknownFormatError) Error() string