hook

Documentation

Index

• type ExecCloser
• type FilterHandle
• type Hook
  • func New(exec ExecCloser, opt ...Option) *Hook
  • func (h *Hook) Fire(entry *logrus.Entry) error
  • func (h *Hook) Flush()
  • func (h *Hook) Levels() []logrus.Level
• type Option
  • func SetExtra(extra map[string]interface{}) Option
  • func SetFilter(filter FilterHandle) Option
  • func SetLevels(levels ...logrus.Level) Option
  • func SetMaxQueues(maxQueues int) Option
  • func SetMaxWorkers(maxWorkers int) Option

Types

type ExecCloser

type ExecCloser interface {
	Exec(entry *logrus.Entry) error
	Close() error
}

ExecCloser write the logrus entry to the store and close the store

type FilterHandle

type FilterHandle func(*logrus.Entry) *logrus.Entry

FilterHandle a filter command

type Hook

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

Hook to send logs to a mongo database

func New

func New(exec ExecCloser, opt ...Option) *Hook

New creates a hook to be added to an instance of logger

func (*Hook) Fire

func (h *Hook) Fire(entry *logrus.Entry) error

Fire is called when a log event is fired

func (*Hook) Flush

func (h *Hook) Flush()

Flush waits for the log queue to be empty

func (*Hook) Levels

func (h *Hook) Levels() []logrus.Level

Levels returns the available logging levels

type Option

type Option func(*options)

Option a hook parameter options

func SetExtra

func SetExtra(extra map[string]interface{}) Option

SetExtra set extended parameters

func SetFilter

func SetFilter(filter FilterHandle) Option

SetFilter set the entry filter

func SetLevels

func SetLevels(levels ...logrus.Level) Option

SetLevels set the available log level

func SetMaxQueues

func SetMaxQueues(maxQueues int) Option

SetMaxQueues set the number of buffers

func SetMaxWorkers

func SetMaxWorkers(maxWorkers int) Option

SetMaxWorkers set the number of worker threads