logging

Documentation

Index

• Constants
• func Debug(msg string)
• func Debugf(msg string, args ...interface{})
• func Error(trace string, err error)
• func Fatal(args ...interface{})
• func Fatalf(msg string, args ...interface{})
• func GenerateUUID() string
• func GetLogFormat() string
• func GetLogger() *logrus.Logger
• func GetRequestID(requestIDParams *string) string
• func Info(msg string)
• func Infof(msg string, args ...interface{})
• func IsJSONLogFormat() bool
• func IsTextLogFormat() bool
• func Panic(args ...interface{})
• func Panicf(msg string, args ...interface{})
• func Printf(msg string, args ...interface{})
• func Println(args ...interface{})
• func Trace() (line string)
• func Warn(msg string)
• func Warnf(msg string, args ...interface{})
• func WithError(err error) *logrus.Entry
• func WithField(key string, value interface{}) *logrus.Entry
• func WithFields(fields logrus.Fields) *logrus.Entry
• type UTCFormatter
  • func (u UTCFormatter) Format(e *log.Entry) ([]byte, error)

Constants

const LogFormatDefault = LogFormatText

LogFormatDefault is the default logging format

const LogFormatJSON = "json"

LogFormatJSON the json logging format

const LogFormatText = "text"

LogFormatText the text logging format

Functions

func Debug

func Debug(msg string)

Debug log message

func Debugf

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

Debugf log message

func Error

func Error(trace string, err error)

Error log message with fields

func Fatal

func Fatal(args ...interface{})

Fatal log message

func Fatalf

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

Fatalf log message

func GenerateUUID

func GenerateUUID() string

GenerateUUID is function to generate our own uuid if the google uuid throws error

func GetLogFormat

func GetLogFormat() string

GetLogFormat returns the configured logging format

func GetLogger

func GetLogger() *logrus.Logger

GetLogger returns an instance of our logger

func GetRequestID

func GetRequestID(requestIDParams *string) string

GetRequestID is function to generate uuid as request id if client doesn't pass X-REQUEST-ID request header

func Info

func Info(msg string)

Info log message

func Infof

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

Infof log message

func IsJSONLogFormat

func IsJSONLogFormat() bool

IsJSONLogFormat returns true if the logging format is JSON

func IsTextLogFormat

func IsTextLogFormat() bool

IsTextLogFormat returns true if the logging format is text

func Panic

func Panic(args ...interface{})

Panic log message

func Panicf

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

Panicf log message

func Printf

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

Printf ...

func Println

func Println(args ...interface{})

Println log message

func Trace

func Trace() (line string)

Trace returns the source code line and function name (of the calling function)

func Warn

func Warn(msg string)

Warn log message

func Warnf

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

Warnf log message

func WithError

func WithError(err error) *logrus.Entry

WithError logs a message with the specified error

func WithField

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

WithField log message with field

func WithFields

func WithFields(fields logrus.Fields) *logrus.Entry

WithFields logs a message with fields

Types

type UTCFormatter

type UTCFormatter struct {
	log.Formatter
}

UTCFormatter structure for logging

func (UTCFormatter) Format

func (u UTCFormatter) Format(e *log.Entry) ([]byte, error)

Format handler for UTC time - usage: log.SetFormatter(UTCFormatter{&log.JSONFormatter{}})