log

Documentation

Index

• Variables
• func NewLogger(logFilename string, logLevel string, logSize int) *logrus.Logger
• func SetGlobalLogger(logFilename string, logLevel string)
• func ToLogFile(filename string) io.Writer
• func ToNull() io.Writer
• func ToStdOut() io.Writer
• type Fields
• type FileLogHook
  • func (hook *FileLogHook) Fire(entry *logrus.Entry) error
  • func (hook *FileLogHook) Levels() []logrus.Level
• type LogFormat
• type Logger
• type Options
  • func WithLevel(level string) Options
  • func WithNullLogger() Options
  • func WithOutput(outputs ...io.Writer) Options

Variables

var (
	// logger instance used by the application
	Global *logrus.Logger
)

Functions

func NewLogger

func NewLogger(logFilename string, logLevel string, logSize int) *logrus.Logger

func SetGlobalLogger

func SetGlobalLogger(logFilename string, logLevel string)

func ToLogFile

func ToLogFile(filename string) io.Writer

ToLogFile returns an io.Writer to configure WithOutput() option to write to a file and manage log rotation using lumberjack.

func ToNull

func ToNull() io.Writer

ToNull returns an io.Writer to configure WithOutput() option to discard all output.

func ToStdOut

func ToStdOut() io.Writer

ToStdOut returns an io.Writer to configure WithOutput() option to write to standard out.

Types

type Fields

type Fields = logrus.Fields

type FileLogHook

type FileLogHook struct {
	Writer    io.Writer
	Formatter logrus.Formatter
}

logrus hook to write log to file

func (*FileLogHook) Fire

func (hook *FileLogHook) Fire(entry *logrus.Entry) error

func (*FileLogHook) Levels

func (hook *FileLogHook) Levels() []logrus.Level

type LogFormat

type LogFormat string

type of log format

const (
	JSONFormat LogFormat = "json"
	TextFormat LogFormat = "text"
)

type Logger

type Logger = logrus.Logger

type Options

type Options func(*Logger)

Options is a function type that can be used to configure the logger

func WithLevel

func WithLevel(level string) Options

WithLevel configures the log level. If level is not specified, default to InfoLevel If level is debug or trace, report caller is enabled

func WithNullLogger

func WithNullLogger() Options

WithNullLogger sets the logger to discard all output

func WithOutput

func WithOutput(outputs ...io.Writer) Options

WithOutput configures the output destination