rotation

Documentation

Overview

Package rotation provides file rotation when files hit a given size.

Index

• Constants
• Variables
• func DefaultPath() string
• func MaxBackups(maxBackups int) func(*Rotator) error
• func MaxSize(maxSize int64) func(*Rotator) error
• func ParseAndSetupLogging(cl *cmdline.CmdLine, consoleOnByDefault bool) []string
• func Path(path string) func(*Rotator) error
• func WithMask(mask os.FileMode) func(*Rotator) error
• type Rotator
  • func New(options ...func(*Rotator) error) (*Rotator, error)
  • func (r *Rotator) Close() error
  • func (r *Rotator) PathToLog() string
  • func (r *Rotator) Sync() error
  • func (r *Rotator) Write(b []byte) (int, error)

Constants

const (
	DefaultMaxSize    = 10 * 1024 * 1024
	DefaultMaxBackups = 1
)

Constants for defaults.

Variables

var PathToLog string

PathToLog holds the path to the log file that was configured on the command line when using ParseAndSetup().

Functions

func DefaultPath

func DefaultPath() string

DefaultPath returns the default path that will be used. This will use cmdline.AppIdentifier (if set) to better isolate the log location.

func MaxBackups

func MaxBackups(maxBackups int) func(*Rotator) error

MaxBackups sets the maximum number of old log files to retain. Defaults to DefaultMaxBackups.

func MaxSize

func MaxSize(maxSize int64) func(*Rotator) error

MaxSize sets the maximum size of the log file before it gets rotated. Defaults to DefaultMaxSize.

func ParseAndSetupLogging

func ParseAndSetupLogging(cl *cmdline.CmdLine, consoleOnByDefault bool) []string

ParseAndSetupLogging adds command-line options for controlling logging, parses the command line, then instantiates a rotator and attaches it to slog. Returns the remaining arguments that weren't used for option content. If consoleOnByDefault is true, then logs will also go to the console by default, but an option to turn them off will be added to the command line flags. Conversely, if it is false, an option to turn them on will be added to the command line flags.

func Path

func Path(path string) func(*Rotator) error

Path specifies the file to write logs to. Backup log files will be retained in the same directory. Defaults to the value of DefaultPath().

func WithMask

func WithMask(mask os.FileMode) func(*Rotator) error

WithMask sets the mask when creating files, which have the unmasked mode of 0644, and directories, which have the unmasked mode of 0755. Defaults to 0777.

Types

type Rotator

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

Rotator holds the rotator data.

func New

func New(options ...func(*Rotator) error) (*Rotator, error)

New creates a new Rotator with the specified options.

func (*Rotator) Close

func (r *Rotator) Close() error

Close implements io.Closer.

func (*Rotator) PathToLog

func (r *Rotator) PathToLog() string

PathToLog returns the path to the log file that will be used.

func (*Rotator) Sync

func (r *Rotator) Sync() error

Sync commits the current contents of the file to stable storage.

func (*Rotator) Write

func (r *Rotator) Write(b []byte) (int, error)

Write implements io.Writer.