filerotator

README

filerotator

Documentation

Index

• Variables
• func CreateFile(filename string) (*os.File, error)
• type Clock
• type FileRotator
  • func New(logFilePath string, opts ...Option) (*FileRotator, error)
  • func (rotator *FileRotator) Close() error
  • func (rotator *FileRotator) Rotate(filename string) error
  • func (rotator *FileRotator) Write(p []byte) (n int, err error)
• type Option
  • func WithClock(clock Clock) Option
  • func WithMaxAge(maxAge time.Duration) Option
  • func WithMaxBackup(maxBackup uint) Option
  • func WithRotateType(rotateType RotateType) Option
  • func WithRotationSize(rotationSize int64) Option
  • func WithRotationTime(rotationTime time.Duration) Option
  • func WithSymlink(symlink string) Option
• type RotateType
  • func ParseRotationType(s string) RotateType

Variables

var Local = clockFn(func() time.Time { return time.Now() })

var UTC = clockFn(func() time.Time { return time.Now().UTC() })

Functions

func CreateFile

func CreateFile(filename string) (*os.File, error)

Types

type Clock

type Clock interface {
	Now() time.Time
}

type FileRotator

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

func New

func New(logFilePath string, opts ...Option) (*FileRotator, error)

func (*FileRotator) Close

func (rotator *FileRotator) Close() error

func (*FileRotator) Rotate

func (rotator *FileRotator) Rotate(filename string) error

func (*FileRotator) Write

func (rotator *FileRotator) Write(p []byte) (n int, err error)

type Option

type Option func(*FileRotator)

func WithClock

func WithClock(clock Clock) Option

func WithMaxAge

func WithMaxAge(maxAge time.Duration) Option

func WithMaxBackup

func WithMaxBackup(maxBackup uint) Option

func WithRotateType

func WithRotateType(rotateType RotateType) Option

func WithRotationSize

func WithRotationSize(rotationSize int64) Option

func WithRotationTime

func WithRotationTime(rotationTime time.Duration) Option

func WithSymlink

func WithSymlink(symlink string) Option

type RotateType

type RotateType uint8

const (
	RotateTypeTime RotateType = iota
	RotateTypeSize
	RotateTypeBoth
)

func ParseRotationType

func ParseRotationType(s string) RotateType