logger

Documentation

Overview

Package logger is the logger builder.

Index

• Constants
• type LogOptions
• type Logger
  • func L() *Logger
  • func NewGinLogger() *Logger
  • func NewGormLogger() *Logger
  • func NewLogger() *Logger
  • func (l *Logger) Named(s string) *Logger
  • func (l *Logger) Printf(format string, args ...interface{})
  • func (l *Logger) With(fields ...interface{}) *Logger
  • func (l *Logger) X(ctx context.Context) *Logger

Constants

const (
	KeyRequestID string = "requestID"
	KeyUsername  string = "username"
)

Defines common log fields.

Types

type LogOptions

type LogOptions struct {
	Name          string
	Development   bool
	DisableCaller bool `mapstructure:"disable-caller"`
}

LogOptions defines options for building a logger.

type Logger

type Logger struct {
	*zap.SugaredLogger
}

func L

func L() *Logger

L returns the global logger.

func NewGinLogger

func NewGinLogger() *Logger

NewGinLogger creates a gin logger.

func NewGormLogger

func NewGormLogger() *Logger

NewGormLogger creates a gorm logger.

func NewLogger

func NewLogger() *Logger

NewLogger creates a logger.

func (*Logger) Named

func (l *Logger) Named(s string) *Logger

Named adds a new path segment to the logger's name. Segments are joined by periods. By default, Loggers are unnamed.

func (*Logger) Printf

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

Printf logs a message at level Print on the compatibleLogger.

func (*Logger) With

func (l *Logger) With(fields ...interface{}) *Logger

With adds a variadic number of fields to the logging context.

func (*Logger) X

func (l *Logger) X(ctx context.Context) *Logger

X adds requestID and username fields to the logging context.