log

Documentation

Index

• func Debug(ctx context.Context, err error)
• func Debugf(ctx context.Context, format string, args ...interface{})
• func Log(ctx context.Context, err error)
• func Logf(ctx context.Context, format string, args ...interface{})
• func RequestID(ctx context.Context) string
• func SetRequestID(ctx context.Context) context.Context
• func WithDebug(ctx context.Context) context.Context
• func WithField(ctx context.Context, field string, value interface{}) context.Context
• func WithFields(ctx context.Context, fields Fields) context.Context
• func WithLogger(ctx context.Context, l *Logger) context.Context
• type Fields
  • func ContextFields(ctx context.Context) Fields
• type Logger
  • func FromContext(ctx context.Context) *Logger
  • func NewLogger() *Logger
  • func (l *Logger) AddErrorMapper(mapper func(context.Context, error) context.Context)
  • func (l *Logger) BackgroundContext() context.Context
  • func (l *Logger) DebugError(ctx context.Context, err error)
  • func (l *Logger) DebugPrintf(ctx context.Context, format string, args ...interface{})
  • func (l *Logger) EnableDebug()
  • func (l *Logger) EnableJSON()
  • func (l *Logger) EnableStacks()
  • func (l *Logger) Error(ctx context.Context, err error)
  • func (l *Logger) ErrorsOnly()
  • func (l *Logger) Logrus() *logrus.Logger
  • func (l *Logger) Printf(ctx context.Context, format string, args ...interface{})
  • func (l *Logger) SetOutput(out io.Writer)
  • func (l *Logger) Write(p []byte) (int, error)

Functions

func Debug

func Debug(ctx context.Context, err error)

Debug will log err if the context has debug logging enabled.

func Debugf

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

Debugf will log the formatted string if the context has debug logging enabled.

func Log

func Log(ctx context.Context, err error)

Log will log an application error.

func Logf

func Logf(ctx context.Context, format string, args ...interface{})

Logf will log application information.

func RequestID

func RequestID(ctx context.Context) string

RequestID will return the associated RequestID or empty string if missing.

func SetRequestID

func SetRequestID(ctx context.Context) context.Context

SetRequestID will assign a unique ID to the context for tracing.

func WithDebug

func WithDebug(ctx context.Context) context.Context

WithDebug will enable debug logging for the context.

func WithField

func WithField(ctx context.Context, field string, value interface{}) context.Context

WithField will return a context with the specified field set to value.

func WithFields

func WithFields(ctx context.Context, fields Fields) context.Context

WithFields will return a context with the provided fields set.

func WithLogger

func WithLogger(ctx context.Context, l *Logger) context.Context

Types

type Fields

type Fields map[string]interface{}

Fields are used to add values in structured logging.

func ContextFields

func ContextFields(ctx context.Context) Fields

ContextFields will return the current set of fields associated with a context.

type Logger

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

func FromContext

func FromContext(ctx context.Context) *Logger

func NewLogger

func NewLogger() *Logger

func (*Logger) AddErrorMapper

func (l *Logger) AddErrorMapper(mapper func(context.Context, error) context.Context)

func (*Logger) BackgroundContext

func (l *Logger) BackgroundContext() context.Context

func (*Logger) DebugError

func (l *Logger) DebugError(ctx context.Context, err error)

func (*Logger) DebugPrintf

func (l *Logger) DebugPrintf(ctx context.Context, format string, args ...interface{})

func (*Logger) EnableDebug

func (l *Logger) EnableDebug()

If EnableDebug is called, all debug messages will be logged.

func (*Logger) EnableJSON

func (l *Logger) EnableJSON()

EnableJSON sets the output log format to JSON

func (*Logger) EnableStacks

func (l *Logger) EnableStacks()

EnableStacks enables stack information via the Source field.

func (*Logger) Error

func (l *Logger) Error(ctx context.Context, err error)

func (*Logger) ErrorsOnly

func (l *Logger) ErrorsOnly()

ErrorsOnly will disable all log output except errors.

func (*Logger) Logrus

func (l *Logger) Logrus() *logrus.Logger

func (*Logger) Printf

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

func (*Logger) SetOutput

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

SetOutput will change the log output.

func (*Logger) Write

func (l *Logger) Write(p []byte) (int, error)

Write is a pass-through for the underlying logger's Write method.