logrus

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package logrus implements the logging API based on the Logrus logger.

Index

Constants

View Source 
const (
	LoggerKey   = "logger"
	FunctionKey = "func"
	LocationKey = "loc"
)

Tag names for structured fields of log entry

Variables

This section is empty.

Functions

This section is empty.

Types

type Entry 

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

Entry is the logging entry. It has logrus' entry struct which is a final or intermediate Logrus logging entry

func NewEntry 

func NewEntry(logger *Logger) *Entry

NewEntry creates net entry object which stores provided logger and logrus' entry

func (*Entry) Debug 

func (entry *Entry) Debug(args ...interface{})

Debug logs a message at level Debug on the standard logger.

func (*Entry) Debugf 

func (entry *Entry) Debugf(format string, args ...interface{})

Debugf logs a message at level Debug on the standard logger.

func (*Entry) Debugln 

func (entry *Entry) Debugln(args ...interface{})

Debugln logs a message at level Debug on the standard logger.

func (*Entry) Error 

func (entry *Entry) Error(args ...interface{})

Error logs a message at level Error on the standard logger.

func (*Entry) Errorf 

func (entry *Entry) Errorf(format string, args ...interface{})

Errorf logs a message at level Error on the standard logger.

func (*Entry) Errorln 

func (entry *Entry) Errorln(args ...interface{})

Errorln logs a message at level Error on the standard logger.

func (*Entry) Fatal 

func (entry *Entry) Fatal(args ...interface{})

Fatal logs a message at level Fatal on the standard logger.

func (*Entry) Fatalf 

func (entry *Entry) Fatalf(format string, args ...interface{})

Fatalf logs a message at level Debug on the standard logger.

func (*Entry) Fatalln 

func (entry *Entry) Fatalln(args ...interface{})

Fatalln logs a message at level Fatal on the standard logger.

func (*Entry) Info 

func (entry *Entry) Info(args ...interface{})

Info logs a message at level Info on the standard logger.

func (*Entry) Infof 

func (entry *Entry) Infof(format string, args ...interface{})

Infof logs a message at level Info on the standard logger.

func (*Entry) Infoln 

func (entry *Entry) Infoln(args ...interface{})

Infoln logs a message at level Info on the standard logger.

func (*Entry) Log 

func (entry *Entry) Log(lvl logrus.Level, args ...interface{})

func (*Entry) Logf 

func (entry *Entry) Logf(lvl logrus.Level, f string, args ...interface{})

func (*Entry) Logln 

func (entry *Entry) Logln(lvl logrus.Level, args ...interface{})

func (*Entry) Panic 

func (entry *Entry) Panic(args ...interface{})

Panic logs a message at level Panic on the standard logger.

func (*Entry) Panicf 

func (entry *Entry) Panicf(format string, args ...interface{})

Panicf logs a message at level Panic on the standard logger.

func (*Entry) Panicln 

func (entry *Entry) Panicln(args ...interface{})

Panicln logs a message at level Panic on the standard logger.

func (*Entry) Print 

func (entry *Entry) Print(args ...interface{})

Print logs a message at level Info on the standard logger.

func (*Entry) Printf 

func (entry *Entry) Printf(format string, args ...interface{})

Printf logs a message at level Info on the standard logger.

func (*Entry) Println 

func (entry *Entry) Println(args ...interface{})

Println logs a message at level Info on the standard logger.

func (*Entry) String 

func (entry *Entry) String() (string, error)

String returns the string representation from the reader or the formatter.

func (*Entry) Trace 

func (entry *Entry) Trace(args ...interface{})

Trace logs a message at level Trace on the standard logger.

func (*Entry) Tracef 

func (entry *Entry) Tracef(format string, args ...interface{})

Tracef logs a message at level Trace on the standard logger.

func (*Entry) Traceln 

func (entry *Entry) Traceln(args ...interface{})

Traceln logs a message at level Trace on the standard logger.

func (*Entry) Warn 

func (entry *Entry) Warn(args ...interface{})

Warn logs a message at level Warning on the standard logger.

func (*Entry) Warnf 

func (entry *Entry) Warnf(format string, args ...interface{})

Warnf logs a message at level Warn on the standard logger.

func (*Entry) Warning 

func (entry *Entry) Warning(args ...interface{})

Warning logs a message at level Warning on the standard logger.

func (*Entry) Warningf 

func (entry *Entry) Warningf(format string, args ...interface{})

Warningf logs a message at level Warn on the standard logger.

func (*Entry) Warningln 

func (entry *Entry) Warningln(args ...interface{})

Warningln logs a message at level Warn on the standard logger.

func (*Entry) Warnln 

func (entry *Entry) Warnln(args ...interface{})

Warnln logs a message at level Warn on the standard logger.

func (*Entry) WithError 

func (entry *Entry) WithError(err error) logging.LogWithLevel

WithError adds error to fields.

func (*Entry) WithField 

func (entry *Entry) WithField(key string, value interface{}) logging.LogWithLevel

WithField calls transforms key/value to field and passes to WithFields

func (*Entry) WithFields 

func (entry *Entry) WithFields(fields logging.Fields) logging.LogWithLevel

WithFields stores field entries. These entries are used later when log method (Info, Debug, etc) is called

type Formatter 

type Formatter struct {
	Function bool
	Location bool
	FullPath bool

	Formatter logrus.Formatter
}

func DefaultFormatter 

func DefaultFormatter() *Formatter

DefaultFormatter returns a formatter used as the default formatter for loggers.

func NewFormatter 

func NewFormatter() *Formatter

func (*Formatter) Format 

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

type LogRegistry 

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

LogRegistry contains logger map and rwlock guarding access to it

func DefaultRegistry 

func DefaultRegistry() *LogRegistry

DefaultRegistry returns the global registry instance.

func NewLogRegistry 

func NewLogRegistry() *LogRegistry

NewLogRegistry is a constructor

func (*LogRegistry) AddHook 

func (lr *LogRegistry) AddHook(hook logrus.Hook)

AddHook applies the hook to existing loggers and adds it to list of hooks to be applies for new loggers.

func (*LogRegistry) ClearRegistry 

func (lr *LogRegistry) ClearRegistry()

ClearRegistry removes all loggers except the default one from registry

func (*LogRegistry) GetLevel 

func (lr *LogRegistry) GetLevel(logger string) (string, error)

GetLevel returns the currently set log level of the logger

func (*LogRegistry) ListLoggers 

func (lr *LogRegistry) ListLoggers() map[string]string

ListLoggers returns a map (loggerName => log level)

func (*LogRegistry) Lookup 

func (lr *LogRegistry) Lookup(loggerName string) (logger logging.Logger, found bool)

Lookup returns a logger instance identified by name from registry

func (*LogRegistry) NewLogger 

func (lr *LogRegistry) NewLogger(name string) logging.Logger

NewLogger creates new named Logger instance. Name can be subsequently used to refer the logger in registry.

func (*LogRegistry) SetLevel 

func (lr *LogRegistry) SetLevel(logger, level string) error

SetLevel modifies log level of selected logger in the registry

type Logger 

type Logger struct {
	Logger *logrus.Logger
	// contains filtered or unexported fields
}

Logger is wrapper of Logrus logger. In addition to Logrus functionality it allows to define static log fields that are added to all subsequent log entries. It also automatically appends file name and line where the log is coming from. In order to distinguish logs from different go routines a tag (number that is based on the stack address) is computed. To achieve better readability numeric value of a tag can be replaced by a string using SetTag function.

func DefaultLogger 

func DefaultLogger() *Logger

DefaultLogger returns a global logger. Note, that recommended approach is to create a custom logger.

func NewLogger 

func NewLogger(name string) *Logger

NewLogger is a constructor creates instances of named logger. This constructor is called from LogRegistry which is useful when log levels needs to be changed by management API (such as REST)

Example: 

logger := NewLogger("MyLogger")
logger.Info("informative message")

func WrapLogger 

func WrapLogger(logger *logrus.Logger, name string) *Logger

WrapLogger wraps logrus.Logger and returns named Logger.

func (*Logger) AddHook 

func (logger *Logger) AddHook(hook logrus.Hook)

func (*Logger) Debug 

func (logger *Logger) Debug(args ...interface{})

Debug logs a message at level Debug on the standard logger.

func (*Logger) Debugf 

func (logger *Logger) Debugf(format string, args ...interface{})

Debugf logs a message at level Debug on the standard logger.

func (*Logger) Debugln 

func (logger *Logger) Debugln(args ...interface{})

Debugln logs a message at level Debug on the standard logger.

func (*Logger) Error 

func (logger *Logger) Error(args ...interface{})

Error logs a message at level Error on the standard logger.

func (*Logger) Errorf 

func (logger *Logger) Errorf(format string, args ...interface{})

Errorf logs a message at level Error on the standard logger.

func (*Logger) Errorln 

func (logger *Logger) Errorln(args ...interface{})

Errorln logs a message at level Error on the standard logger.

func (*Logger) Fatal 

func (logger *Logger) Fatal(args ...interface{})

Fatal logs a message at level Fatal on the standard logger.

func (*Logger) Fatalf 

func (logger *Logger) Fatalf(format string, args ...interface{})

Fatalf logs a message at level Fatal on the standard logger.

func (*Logger) Fatalln 

func (logger *Logger) Fatalln(args ...interface{})

Fatalln logs a message at level Fatal on the standard logger.

func (*Logger) GetLevel 

func (logger *Logger) GetLevel() logging.LogLevel

func (*Logger) GetName 

func (logger *Logger) GetName() string

func (*Logger) GetStaticFields 

func (logger *Logger) GetStaticFields() map[string]interface{}

GetStaticFields returns currently set map of static fields - key-value pairs that are automatically added into log entry

func (*Logger) Info 

func (logger *Logger) Info(args ...interface{})

Info logs a message at level Info on the standard logger.

func (*Logger) Infof 

func (logger *Logger) Infof(format string, args ...interface{})

Infof logs a message at level Info on the standard logger.

func (*Logger) Infoln 

func (logger *Logger) Infoln(args ...interface{})

Infoln logs a message at level Info on the standard logger.

func (*Logger) Log 

func (logger *Logger) Log(lvl logrus.Level, args ...interface{})

func (*Logger) Logf 

func (logger *Logger) Logf(lvl logrus.Level, f string, args ...interface{})

func (*Logger) Logln 

func (logger *Logger) Logln(lvl logrus.Level, args ...interface{})

func (*Logger) Panic 

func (logger *Logger) Panic(args ...interface{})

Panic logs a message at level Panic on the standard logger.

func (*Logger) Panicf 

func (logger *Logger) Panicf(format string, args ...interface{})

Panicf logs a message at level Panic on the standard logger.

func (*Logger) Panicln 

func (logger *Logger) Panicln(args ...interface{})

Panicln logs a message at level Panic on the standard logger.

func (*Logger) Print 

func (logger *Logger) Print(args ...interface{})

Print logs a message at level Info on the standard logger.

func (*Logger) Printf 

func (logger *Logger) Printf(format string, args ...interface{})

Printf logs a message at level Info on the standard logger.

func (*Logger) Println 

func (logger *Logger) Println(args ...interface{})

Println logs a message at level Info on the standard logger.

func (*Logger) SetFormatter 

func (logger *Logger) SetFormatter(formatter logrus.Formatter)

func (*Logger) SetLevel 

func (logger *Logger) SetLevel(lvl logging.LogLevel)

func (*Logger) SetOutput 

func (logger *Logger) SetOutput(out io.Writer)

func (*Logger) SetReportCaller 

func (logger *Logger) SetReportCaller(enable bool)

func (*Logger) SetStaticFields 

func (logger *Logger) SetStaticFields(fields map[string]interface{})

SetStaticFields sets a map of fields that will be part of the each subsequent log entry of the logger

func (*Logger) SetVerbosity 

func (logger *Logger) SetVerbosity(v int)

SetVerbosity allows to set a logger verbosity. The verbosity can be used in custom loggers passed to external libraries (like GRPC) and may not correspond with the Logger plugin log levels. See the documentation of the given library to learn about supported verbosity levels.

func (*Logger) StandardLogger 

func (logger *Logger) StandardLogger() *logrus.Logger

func (*Logger) Trace 

func (logger *Logger) Trace(args ...interface{})

Trace logs a message at level Trace on the standard logger.

func (*Logger) Tracef 

func (logger *Logger) Tracef(format string, args ...interface{})

Tracef logs a message at level Trae on the standard logger.

func (*Logger) Traceln 

func (logger *Logger) Traceln(args ...interface{})

Traceln logs a message at level Trace on the standard logger.

func (*Logger) V 

func (logger *Logger) V(l int) bool

V reports whether verbosity level is at least at the requested level

func (*Logger) Warn 

func (logger *Logger) Warn(args ...interface{})

Warn logs a message at level Warning on the standard logger.

func (*Logger) Warnf 

func (logger *Logger) Warnf(format string, args ...interface{})

Warnf logs a message at level Warn on the standard logger.

func (*Logger) Warning 

func (logger *Logger) Warning(args ...interface{})

Warning logs a message at level Warn on the standard logger.

func (*Logger) Warningf 

func (logger *Logger) Warningf(format string, args ...interface{})

Warningf logs a message at level Warn on the standard logger.

func (*Logger) Warningln 

func (logger *Logger) Warningln(args ...interface{})

Warningln logs a message at level Warn on the standard logger.

func (*Logger) Warnln 

func (logger *Logger) Warnln(args ...interface{})

Warnln logs a message at level Warn on the standard logger.

func (*Logger) WithContext 

func (logger *Logger) WithContext(ctx context.Context) logging.LogWithLevel

func (*Logger) WithError 

func (logger *Logger) WithError(err error) logging.LogWithLevel

func (*Logger) WithField 

func (logger *Logger) WithField(key string, value interface{}) logging.LogWithLevel

WithField creates an entry from the standard logger and adds a field to it. If you want multiple fields, use `WithFields`.

Note that it doesn't log until you call Debug, Print, Info, Warn, Fatal or Panic on the LogMsg it returns.

func (*Logger) WithFields 

func (logger *Logger) WithFields(fields logging.Fields) logging.LogWithLevel

WithFields creates an entry from the standard logger and adds multiple fields to it. This is simply a helper for `WithField`, invoking it once for each field.

Note that it doesn't log until you call Debug, Print, Info, Warn, Fatal or Panic on the LogMsg it returns.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.