rotate

Documentation

Index

• Constants
• Variables
• func Location() *time.Location
• func NewRotateLogger(rcfg *Config) (*rotatelogs.RotateLogs, error)
• func NewWriter(opts ...Option) (io.Writer, error)
• type Config
  • func NewWriterConfig() *Config
• type Option
  • func WithAge(Age time.Duration) Option
  • func WithCount(Count uint) Option
  • func WithDuration(Duration time.Duration) Option
  • func WithFileMode(Perm os.FileMode) Option
  • func WithFilename(fn string) Option
  • func WithLocation(loc *time.Location) Option
  • func WithLogDir(dir string) Option
  • func WithLogSubDir(dir string) Option
  • func WithPattern(Pattern string) Option

Constants

const (
	DefaultRotateMaxAge               = 7 * 24 * time.Hour
	DefaultRotateDuration             = 24 * time.Hour
	DefaultRotatePattern              = ".%Y%m%d%H%M"
	DefaultLogDir                     = "/data/log"
	DefaultLogSubDir                  = "info"
	DefaultFileMode       os.FileMode = 0755
)

Variables

var (
	DefaultFilename = filepath.Base(os.Args[0])
	DefaultLocation = Location()
)

Functions

func Location

func Location() *time.Location

func NewRotateLogger

func NewRotateLogger(rcfg *Config) (*rotatelogs.RotateLogs, error)

func NewWriter

func NewWriter(opts ...Option) (io.Writer, error)

Types

type Config

type Config struct {
	Dir      string
	Sub      string
	Filename string
	Perm     os.FileMode
	Age      time.Duration
	Duration time.Duration
	Pattern  string
	Count    uint
	Loc      *time.Location
}

func NewWriterConfig

func NewWriterConfig() *Config

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithAge

func WithAge(Age time.Duration) Option

func WithCount

func WithCount(Count uint) Option

sets the number of files should be kept before it gets purged from the file system.

func WithDuration

func WithDuration(Duration time.Duration) Option

func WithFileMode

func WithFileMode(Perm os.FileMode) Option

func WithFilename

func WithFilename(fn string) Option

func WithLocation

func WithLocation(loc *time.Location) Option

func WithLogDir

func WithLogDir(dir string) Option

func WithLogSubDir

func WithLogSubDir(dir string) Option

func WithPattern

func WithPattern(Pattern string) Option