selfrotate

Documentation

Overview

Package selfrotate provides zap sync that automatically rotates log files according to provided config.

Index

• Constants
• type Compress
• type Options
• type RotateInterval
• type Writer
  • func New(options Options) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Sync() error
  • func (w *Writer) Write(b []byte) (int, error)

Constants

const (
	RotateHourly = RotateInterval(time.Hour)
	RotateDaily  = RotateInterval(time.Hour * 24)
)

Types

type Compress

type Compress int

const (
	// Never compress output files.
	CompressNone Compress = iota

	// Compress file in background after rotation.
	//
	// This policy is useful when used together with default zap core, because log file is guaranteed to be consistent,
	// even if go program crashes in the middle of file operation.
	CompressDelayed

	// Compress output lines before writing them to file.
	//
	// This policy applies gzip compression to each individual buffer passed to Write(). Only useful together with
	// async zap core that does log line batching.
	CompressAtomic
)

type Options

type Options struct {
	// Name is path to first output file.
	Name string

	// MaxKeep is maximal number of log files to keep.
	//
	// If MaxKeep == 0, count based rotation is disabled.
	MaxKeep int

	// MaxSize limits number of log files to keep, based of total file size in bytes.
	//
	// If MaxSize == 0, size based rotation is disabled.
	MaxSize int64

	// MinFreeSpace limits number of log files based of free space available on log file partition.
	MinFreeSpace float64

	// Compress configures log compression policy.
	Compress Compress

	// RotateInterval specifies rotation interval for logs.
	//
	// By default, rotate every hour.
	RotateInterval RotateInterval
}

type RotateInterval

type RotateInterval time.Duration

type Writer

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

func New

func New(options Options) (*Writer, error)

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Sync

func (w *Writer) Sync() error

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)