log

Documentation

Index

• Constants
• func GetDBLoggerLevel() int
• func InitLogger(config LoggerConfig) *logrus.Logger
• func SetDBLoggerLevel(logLevel int)
• type CallerHook
  • func (hook *CallerHook) Fire(entry *logrus.Entry) error
  • func (hook *CallerHook) Levels() []logrus.Level
• type CostDurationHook
  • func (hook *CostDurationHook) Fire(entry *logrus.Entry) error
  • func (hook *CostDurationHook) Levels() []logrus.Level
• type FieldMap
• type LoggerConfig
• type TextFormatter
  • func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)
• type TraceIdKey

Constants

const (
	// Silent is silent log level
	Silent = iota + 1
	// Error is error log level
	Error
	// Warn is warn log level
	Warn
	// Info is info log level
	Info
)

const (
	FieldKeyLine     = "line"
	FieldKeyDuration = "duration"
)

const (
	StartTimeKey = "startTime"
)

Functions

func GetDBLoggerLevel

func GetDBLoggerLevel() int

func InitLogger

func InitLogger(config LoggerConfig) *logrus.Logger

func SetDBLoggerLevel

func SetDBLoggerLevel(logLevel int)

Types

type CallerHook

type CallerHook struct{}

func (*CallerHook) Fire

func (hook *CallerHook) Fire(entry *logrus.Entry) error

func (*CallerHook) Levels

func (hook *CallerHook) Levels() []logrus.Level

type CostDurationHook

type CostDurationHook struct{}

func (*CostDurationHook) Fire

func (hook *CostDurationHook) Fire(entry *logrus.Entry) error

func (*CostDurationHook) Levels

func (hook *CostDurationHook) Levels() []logrus.Level

type FieldMap

type FieldMap map[string]string

field alias

type LoggerConfig

type LoggerConfig struct {
	Level      string `yaml:"level"`
	Filename   string `yaml:"filename"`
	MaxSize    int    `yaml:"maxsize"`
	MaxAge     int    `yaml:"maxage"`
	MaxBackups int    `yaml:"maxbackups"`
	LocalTime  bool   `yaml:"localtime"`
	Compress   bool   `yaml:"compress"`
}

type TextFormatter

type TextFormatter struct {
	// Set to true to bypass checking for a TTY before outputting colors.
	ForceColors bool

	// Force disabling colors.
	DisableColors bool

	// Force quoting of all values
	ForceQuote bool

	// DisableQuote disables quoting for all values.
	// DisableQuote will have a lower priority than ForceQuote.
	// If both of them are set to true, quote will be forced on all values.
	DisableQuote bool

	// Override coloring based on CLICOLOR and CLICOLOR_FORCE.
	EnvironmentOverrideColors bool

	// Disable timestamp logging. useful when output is redirected to logging
	// system that already adds timestamps.
	DisableTimestamp bool

	// Enable logging the full timestamp when a TTY is attached instead of just
	// the time passed since beginning of execution.
	FullTimestamp bool

	// TimestampFormat to use for display when a full timestamp is printed
	TimestampFormat string

	// The fields are sorted by default for a consistent output. For applications
	// that log extremely frequently and don't use the JSON formatter this may not
	// be desired.
	DisableSorting bool

	// The keys sorting function, when uninitialized it uses sort.Strings.
	SortingFunc func([]string)

	// Disables the truncation of the level text to 4 characters.
	DisableLevelTruncation bool

	// PadLevelText Adds padding the level text so that all the levels output at the same length
	// PadLevelText is a superset of the DisableLevelTruncation option
	PadLevelText bool

	// QuoteEmptyFields will wrap empty fields in quotes if true
	QuoteEmptyFields bool

	// FieldMap allows users to customize the names of keys for default fields.
	// As an example:
	// formatter := &TextFormatter{
	//     FieldMap: FieldMap{
	//         FieldKeyTime:  "@timestamp",
	//         FieldKeyLevel: "@level",
	//         FieldKeyMsg:   "@message"}}
	FieldMap FieldMap

	// CallerPrettyfier can be set by the user to modify the content
	// of the function and file keys in the data when ReportCaller is
	// activated. If any of the returned value is the empty string the
	// corresponding key will be removed from fields.
	CallerPrettyfier func(*runtime.Frame) (function string, file string)
	// contains filtered or unexported fields
}

TextFormatter formats logs into text

func (*TextFormatter) Format

func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)

Format renders a single log entry

type TraceIdKey

type TraceIdKey struct{}