logo

Documentation

Index

• Variables
• func AddHook(hook Hook)
• func SetFormatter(formatter Formatter)
• func SetLevel(level Level)
• func SetOutput(output io.Writer)
• func SetReportCaller(reportCaller bool)
• type DefaultFieldsHook
  • func (h *DefaultFieldsHook) Fire(entry *Entry) error
  • func (h *DefaultFieldsHook) Levels() []Level
• type Entry
  • func WithFields(fields Fields) *Entry
• type Fields
• type Formatter
• type Hook
• type JSONFormatter
• type Level
• type Logger
  • func D(message ...any) *Logger
  • func Debug(summary string, data any, message ...any) *Logger
  • func Debugf(summary string, data any, format string, a ...any) *Logger
  • func Df(format string, a ...any) *Logger
  • func E(message ...any) *Logger
  • func Ef(format string, a ...any) *Logger
  • func Error(summary string, data any, message ...any) *Logger
  • func Errorf(summary string, data any, format string, a ...any) *Logger
  • func F(message ...any) *Logger
  • func Fatal(summary string, data any, message ...any) *Logger
  • func Fatalf(summary string, data any, format string, a ...any) *Logger
  • func Ff(format string, a ...any) *Logger
  • func I(message ...any) *Logger
  • func If(format string, a ...any) *Logger
  • func Info(summary string, data any, message ...any) *Logger
  • func Infof(summary string, data any, format string, a ...any) *Logger
  • func P(message ...any) *Logger
  • func Panic(summary string, data any, message ...any) *Logger
  • func Panicf(summary string, data any, format string, a ...any) *Logger
  • func Pf(format string, a ...any) *Logger
  • func T(summary string, data any, message ...any) *Logger
  • func Tf(summary string, data any, format string, a ...any) *Logger
  • func Trace(summary string, data any, message ...any) *Logger
  • func Tracef(summary string, data any, format string, a ...any) *Logger
  • func W(message ...any) *Logger
  • func Warn(summary string, data any, message ...any) *Logger
  • func Warnf(summary string, data any, format string, a ...any) *Logger
  • func Wf(format string, a ...any) *Logger
• type TextFormatter

Variables

var AllLevels = []Level{
	PanicLevel,
	FatalLevel,
	ErrorLevel,
	WarnLevel,
	InfoLevel,
	DebugLevel,
	TraceLevel,
}

Functions

func AddHook

func AddHook(hook Hook)

func SetFormatter

func SetFormatter(formatter Formatter)

func SetLevel

func SetLevel(level Level)

func SetOutput

func SetOutput(output io.Writer)

func SetReportCaller

func SetReportCaller(reportCaller bool)

Types

type DefaultFieldsHook

type DefaultFieldsHook struct {
	Info runtimekit.StackTraceInfo
}

func (*DefaultFieldsHook) Fire

func (h *DefaultFieldsHook) Fire(entry *Entry) error

func (*DefaultFieldsHook) Levels

func (h *DefaultFieldsHook) Levels() []Level

type Entry

type Entry = logrus.Entry

func WithFields

func WithFields(fields Fields) *Entry

type Fields

type Fields = logrus.Fields

type Formatter

type Formatter = logrus.Formatter

type Hook

type Hook = logrus.Hook

type JSONFormatter

type JSONFormatter = logrus.JSONFormatter

type Level

type Level = logrus.Level

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel Level = iota
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel
)

type Logger

type Logger struct {
	logrus.Logger
}

func D

func D(message ...any) *Logger

func Debug

func Debug(summary string, data any, message ...any) *Logger

func Debugf

func Debugf(summary string, data any, format string, a ...any) *Logger

func Df

func Df(format string, a ...any) *Logger

func E

func E(message ...any) *Logger

func Ef

func Ef(format string, a ...any) *Logger

func Error

func Error(summary string, data any, message ...any) *Logger

func Errorf

func Errorf(summary string, data any, format string, a ...any) *Logger

func F

func F(message ...any) *Logger

func Fatal

func Fatal(summary string, data any, message ...any) *Logger

func Fatalf

func Fatalf(summary string, data any, format string, a ...any) *Logger

func Ff

func Ff(format string, a ...any) *Logger

func I

func I(message ...any) *Logger

func If

func If(format string, a ...any) *Logger

func Info

func Info(summary string, data any, message ...any) *Logger

func Infof

func Infof(summary string, data any, format string, a ...any) *Logger

func P

func P(message ...any) *Logger

func Panic

func Panic(summary string, data any, message ...any) *Logger

func Panicf

func Panicf(summary string, data any, format string, a ...any) *Logger

func Pf

func Pf(format string, a ...any) *Logger

func T

func T(summary string, data any, message ...any) *Logger

func Tf

func Tf(summary string, data any, format string, a ...any) *Logger

func Trace

func Trace(summary string, data any, message ...any) *Logger

func Tracef

func Tracef(summary string, data any, format string, a ...any) *Logger

func W

func W(message ...any) *Logger

func Warn

func Warn(summary string, data any, message ...any) *Logger

func Warnf

func Warnf(summary string, data any, format string, a ...any) *Logger

func Wf

func Wf(format string, a ...any) *Logger

type TextFormatter

type TextFormatter = logrus.TextFormatter