rotatefilehook

README

RotateFileHook

This is a simple hook for logrus to write log files using https://github.com/natefinch/lumberjack

import (
  "github.com/ik5/rotatefilehook"
)

rotateFileHook, err := rotatefilehook.NewRotateFileHook(rotatefilehook.RotateFileConfig{
    Filename: "logfile.log",
    MaxSize: 5,
    MaxBackups: 7,
    MaxAge: 7,
    Level: logrus.LevelDebug,
    Formatter: logrus.TextFormatter,
})
if err != nil {
  panic(err)
}

log.Hooks.Add(rotateFileHook)

err = rotateFileHook.Rotate() // To force rotation
if err != nil {
  panic(err)
}

Documentation

Index

• type RotateFileConfig
• type RotateFileHook
  • func NewRotateFileHook(config RotateFileConfig) (*RotateFileHook, error)
  • func (hook *RotateFileHook) Fire(entry *logrus.Entry) (err error)
  • func (hook *RotateFileHook) Levels() []logrus.Level
  • func (hook *RotateFileHook) Rotate() error

Types

type RotateFileConfig

type RotateFileConfig struct {
	Filename   string
	MaxSize    int
	MaxBackups int
	MaxAge     int
	Level      logrus.Level
	Formatter  logrus.Formatter
	LocalTime  bool
	Compress   bool
}

RotateFileConfig holds basic information for using lumberjack and logrus hooks

type RotateFileHook

type RotateFileHook struct {
	Config    RotateFileConfig
	LogWriter *lumberjack.Logger
}

RotateFileHook holds hook information for logrus

func NewRotateFileHook

func NewRotateFileHook(config RotateFileConfig) (*RotateFileHook, error)

NewRotateFileHook initialize a new logrus.Hook or return an error

func (*RotateFileHook) Fire

func (hook *RotateFileHook) Fire(entry *logrus.Entry) (err error)

Fire implements the Fire interface method of logrus Hook

func (*RotateFileHook) Levels

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

Levels implements the Levels interface method of logrus Hook

func (*RotateFileHook) Rotate

func (hook *RotateFileHook) Rotate() error

Rotate by request a log file (calling of SIGHUP for example)