RFC3339NanoFixed is time.RFC3339Nano with nanoseconds padded using zeros to ensure the formatted time is always the same number of characters.
const RFC3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
G is a shorthand for GetLogger.
We may want to define this locally to a package to get package tagged log messages.
var G = GetLogger
L is an alias for the standard logger.
var L = &Entry{ Logger: logrus.StandardLogger(), Data: make(Fields, 6), }
func SetFormat(format OutputFormat) error
SetFormat sets the log output format (TextFormat or JSONFormat).
func SetLevel(level string) error
SetLevel sets log level globally. It returns an error if the given level is not supported.
level can be one of:
func WithLogger(ctx context.Context, logger *Entry) context.Context
WithLogger returns a new context with the provided logger. Use in combination with logger.WithField(s) for great effect.
Entry is a logging entry. It contains all the fields passed with [Entry.WithFields]. It's finally logged when Trace, Debug, Info, Warn, Error, Fatal or Panic is called on it. These objects can be reused and passed around as much as you wish to avoid field duplication.
Entry is a transitional type, and currently an alias for logrus.Entry.
type Entry = logrus.Entry
func GetLogger(ctx context.Context) *Entry
GetLogger retrieves the current logger from the context. If no logger is available, the default logger is returned.
Fields type to pass to "WithFields".
type Fields = map[string]any
Level is a logging level.
type Level = logrus.Level
Supported log levels.
const (
// TraceLevel level. Designates finer-grained informational events
// than [DebugLevel].
TraceLevel Level = logrus.TraceLevel
// DebugLevel level. Usually only enabled when debugging. Very verbose
// logging.
DebugLevel Level = logrus.DebugLevel
// InfoLevel level. General operational entries about what's going on
// inside the application.
InfoLevel Level = logrus.InfoLevel
// WarnLevel level. Non-critical entries that deserve eyes.
WarnLevel Level = logrus.WarnLevel
// ErrorLevel level. Logs errors that should definitely be noted.
// Commonly used for hooks to send errors to an error tracking service.
ErrorLevel Level = logrus.ErrorLevel
// FatalLevel level. Logs and then calls "logger.Exit(1)". It exits
// even if the logging level is set to Panic.
FatalLevel Level = logrus.FatalLevel
// PanicLevel level. This is the highest level of severity. Logs and
// then calls panic with the message passed to Debug, Info, ...
PanicLevel Level = logrus.PanicLevel
)
func GetLevel() Level
GetLevel returns the current log level.
OutputFormat specifies a log output format.
type OutputFormat string
Supported log output formats.
const (
// TextFormat represents the text logging format.
TextFormat OutputFormat = "text"
// JSONFormat represents the JSON logging format.
JSONFormat OutputFormat = "json"
)