logger

package
v1.0.3-0...-554643c Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	PanicLevel = logrus.PanicLevel
	FatalLevel = logrus.FatalLevel
	ErrorLevel = logrus.ErrorLevel
	WarnLevel  = logrus.WarnLevel
	InfoLevel  = logrus.InfoLevel
	DebugLevel = logrus.DebugLevel
	TraceLevel = logrus.TraceLevel
	AllLevels  = logrus.AllLevels
)

Functions

func AddHook 

func AddHook(hook Hook)

AddHook adds a hook to the standard logger hooks.

func Debug 

func Debug(args ...interface{})

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

func Debugf 

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

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

func Debugln 

func Debugln(args ...interface{})

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

func Error 

func Error(args ...interface{})

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

func Errorf 

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

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

func Errorln 

func Errorln(args ...interface{})

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

func Fatal 

func Fatal(args ...interface{})

Fatal logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func Fatalf 

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

Fatalf logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func Fatalln 

func Fatalln(args ...interface{})

Fatalln logs a message at level Fatal on the standard logger then the process will exit with status set to 1.

func Info 

func Info(args ...interface{})

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

func Infof 

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

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

func Infoln 

func Infoln(args ...interface{})

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

func IsLevelEnabled 

func IsLevelEnabled(level Level) bool

IsLevelEnabled checks if the log level of the standard logger is greater than the level param

func Panic 

func Panic(args ...interface{})

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

func Panicf 

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

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

func Panicln 

func Panicln(args ...interface{})

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

func Print 

func Print(args ...interface{})

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

func Printf 

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

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

func Println 

func Println(args ...interface{})

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

func SetFormatter 

func SetFormatter(formatter RusFormatter)

SetFormatter sets the standard logger formatter.

func SetLevel 

func SetLevel(level Level)

SetLevel sets the standard logger level.

func SetOutput 

func SetOutput(out io.Writer)

SetOutput sets the standard logger output.

func SetReportCaller 

func SetReportCaller(include bool)

SetReportCaller sets whether the standard logger will include the calling method as a field.

func SetupLogger 

func SetupLogger(logger *logrus.Logger)

func StandardLogger 

func StandardLogger() *logrus.Logger

func Trace 

func Trace(args ...interface{})

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

func Tracef 

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

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

func Traceln 

func Traceln(args ...interface{})

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

func Warn 

func Warn(args ...interface{})

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

func Warnf 

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

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

func Warning 

func Warning(args ...interface{})

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

func Warningf 

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

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

func Warningln 

func Warningln(args ...interface{})

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

func Warnln 

func Warnln(args ...interface{})

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

Types

type Config 

type Config struct {
	// TimestampFormat sets the format used for marshaling timestamps.
	TimestampFormat string

	// DisableTimestamp allows disabling automatic timestamps in output
	DisableTimestamp bool

	// DisableHTMLEscape allows disabling html escaping in output
	DisableHTMLEscape bool

	// DataKey allows users to put all the log entry parameters into a nested dictionary at a given key.
	DataKey string

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

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

	// PrettyPrint will indent all json logs
	PrettyPrint bool

	// //// Text RusFormatter
	// 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. - https://bixense.com/clicolors/
	EnvironmentOverrideColors bool

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

	// 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
}

type Entry 

type Entry = logrus.Entry

func WithContext 

func WithContext(ctx context.Context) *Entry

WithContext creates an entry from the standard logger and adds a context to it.

func WithError 

func WithError(err error) *Entry

WithError creates an entry from the standard logger and adds an error to it, using the value defined in ErrorKey as key.

func WithField 

func WithField(key string, value interface{}) *Entry

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 Entry it returns.

func WithFields 

func WithFields(fields Fields) *Entry

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 Entry it returns.

func WithTime 

func WithTime(t time.Time) *Entry

WithTime creates an entry from the standard logger and overrides the time of logs generated with it.

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

type FieldMap 

type FieldMap = logrus.FieldMap

type Fields 

type Fields = logrus.Fields

type Formatter 

type Formatter struct {
	Config Config
	// contains filtered or unexported fields
}

func (*Formatter) Format 

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

type Hook 

type Hook = logrus.Hook

type JSONFormatter 

type JSONFormatter = logrus.JSONFormatter

type Level 

type Level = logrus.Level

func GetLevel 

func GetLevel() Level

GetLevel returns the standard logger level.

type Logger 

type Logger struct {
	*logrus.Logger
	Prefix string
}

func NewLogger 

func NewLogger(opts ...Option) *Logger

func (*Logger) Debug 

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

func (*Logger) Debugf 

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

func (*Logger) Debugln 

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

func (*Logger) Error 

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

func (*Logger) Errorf 

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

func (*Logger) Errorln 

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

func (*Logger) Fatal 

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

func (*Logger) Fatalf 

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

func (*Logger) Fatalln 

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

func (*Logger) Info 

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

func (*Logger) Infof 

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

func (*Logger) Infoln 

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

func (*Logger) Log 

func (l *Logger) Log(level Level, args ...interface{})

func (*Logger) Logf 

func (l *Logger) Logf(level Level, format string, args ...interface{})

func (*Logger) Logln 

func (l *Logger) Logln(level Level, args ...interface{})

func (*Logger) Panic 

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

func (*Logger) Panicf 

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

func (*Logger) Panicln 

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

func (*Logger) Print 

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

func (*Logger) Printf 

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

func (*Logger) Println 

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

func (*Logger) Trace 

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

func (*Logger) Tracef 

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

func (*Logger) Traceln 

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

func (*Logger) Warn 

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

func (*Logger) Warnf 

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

func (*Logger) Warning 

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

func (*Logger) Warningf 

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

func (*Logger) Warningln 

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

func (*Logger) Warnln 

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

func (*Logger) WithField 

func (l *Logger) WithField(key string, value interface{}) *Entry

WithField allocates a new entry and adds a field to it. Debug, Print, Info, Warn, Error, Fatal or Panic must be then applied to this new returned entry. If you want multiple fields, use `WithFields`.

func (*Logger) WithFields 

func (l *Logger) WithFields(fields Fields) *Entry

WithFields Adds a struct of fields to the log entry. All it does is call `WithField` for each `Field`.

func (*Logger) WithPrefix 

func (l *Logger) WithPrefix(prefix string) *Entry

WithPrefix Adds a struct of fields to the log entry. All it does is call `WithField` for each `Field`.

type Option 

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

func WithFormatter 

func WithFormatter(f RusFormatter) Option

func WithPrefix 

func WithPrefix(format string, v ...interface{}) Option

type PrefixHook 

type PrefixHook struct{}

func (*PrefixHook) Fire 

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

func (*PrefixHook) Levels 

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

type RusFormatter 

type RusFormatter = logrus.Formatter

type TextFormatter 

type TextFormatter = logrus.TextFormatter

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.