hooks

package

v0.0.5 Latest Latest Go to latest Published: Apr 28, 2021 License: MIT Imports: 7 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

ContextHook represents a hook for logrus logger.

func NewContextHook(contextKey interface{}, fn func(entry *log.Entry, ctxValue interface{})) *ContextHook

NewContextHook creates a new ContextHook instance

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

Fire implements logrus.ContextHook.Fire()

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

Levels implements logrus.ContextHook.Levels()

type ContextHookFormatFn func(ctxValue interface{}, msg string) string

ContextHookFormatFn is the callback function for formating message

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

FileHook is a hook to handle writing to local log files.

func NewFileHook(filename string) *FileHook

NewFileHook returns new FileHook instance with default values.

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

Fire writes the log file to defined filename path.

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

Levels returns configured log levels.

func (hook *FileHook) SetFormatter(formatter logrus.Formatter)

SetFormatter sets the format that will be used by hook.

func (hook *FileHook) SetMaxAge(maxAge time.Duration)

SetMaxAge sets the maximum duration to retain old log files based on the timestamp encoded in their filename.

func (hook *FileHook) SetMaxSize(maxSize int)

SetMaxSize sets the maximum size in megabytes of the log file before it gets rotated.