log

Documentation

Index

• Constants
• Variables
• func GetLogger(ctx context.Context) *logrus.Entry
• func SetFormat(format string) error
• func SetLevel(level string) error
• func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context
• type Fields
• type Level
  • func GetLevel() Level

Constants

const (
	// RFC3339NanoFixed is time.RFC3339Nano with nanoseconds padded using zeros to
	// ensure the formatted time is always the same number of characters.
	RFC3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"

	// TextFormat represents the text logging format
	TextFormat = "text"

	// JSONFormat represents the JSON logging format
	JSONFormat = "json"

	// TraceLevel level.
	TraceLevel = logrus.TraceLevel

	// DebugLevel level.
	DebugLevel = logrus.DebugLevel

	// InfoLevel level.
	InfoLevel = logrus.InfoLevel
)

Variables

var (
	// G is an alias for GetLogger.
	//
	// We may want to define this locally to a package to get package tagged log
	// messages.
	G = GetLogger

	// L is an alias for the standard logger.
	L = logrus.NewEntry(logrus.StandardLogger())
)

Functions

func GetLogger

func GetLogger(ctx context.Context) *logrus.Entry

GetLogger retrieves the current logger from the context. If no logger is available, the default logger is returned.

func SetFormat

func SetFormat(format string) error

SetFormat sets log output format

func SetLevel

func SetLevel(level string) error

SetLevel sets log level globally.

func WithLogger

func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context

WithLogger returns a new context with the provided logger. Use in combination with logger.WithField(s) for great effect.

Types

type Fields

type Fields = logrus.Fields

Fields type to pass to `WithFields`, alias from `logrus`.

type Level

type Level = logrus.Level

Level is a logging level

func GetLevel

func GetLevel() Level

GetLevel returns the current log level.