logfile

Documentation

Index

• Constants
• type BaseLogFile
  • func (b *BaseLogFile) Close() error
  • func (b *BaseLogFile) Path() string
  • func (b *BaseLogFile) Rotate() (err error)
  • func (b *BaseLogFile) Write(p []byte) (int, error)
  • func (b *BaseLogFile) WriteString(s string) (int, error)
• type LogFile
• type SizeRotateLogFile
  • func OpenSizeRotateLogFile(path string, perm os.FileMode, size int64) (*SizeRotateLogFile, error)
  • func (l *SizeRotateLogFile) RotRoutine()
• type TimeRotateLogFile
  • func OpenTimeRotateLogFile(path string, perm os.FileMode, drot time.Duration) (l *TimeRotateLogFile, err error)
  • func (l *TimeRotateLogFile) Close() error
  • func (l *TimeRotateLogFile) RotRoutine()

Constants

const (

	//KB Kilobytes
	KB = 1 << (10 * iota)
	//MB Megabytes
	MB
	//GB Gigabytes
	GB
	//TB Terabytes
	TB

	// DefaultRotationRate defines the default value for rotation refresh rate
	DefaultRotationRate = time.Millisecond * 250
)

Types

type BaseLogFile

type BaseLogFile struct {
	sync.Mutex
	// contains filtered or unexported fields
}

BaseLogFile structure definition

func (*BaseLogFile) Close

func (b *BaseLogFile) Close() error

Close implements LogFile interface

func (*BaseLogFile) Path

func (b *BaseLogFile) Path() string

Path implements LogFile interface

func (*BaseLogFile) Rotate

func (b *BaseLogFile) Rotate() (err error)

Rotate implements LogFile interface

func (*BaseLogFile) Write

func (b *BaseLogFile) Write(p []byte) (int, error)

Write implements LogFile interface

func (*BaseLogFile) WriteString

func (b *BaseLogFile) WriteString(s string) (int, error)

WriteString implements LogFile interface

type LogFile

type LogFile interface {
	// Path returns the path of the current LogFile
	Path() string
	// Rotate ensures file rotation
	Rotate() error
	// Rotation routine
	RotRoutine()
	// Write used to write to the LogFile
	Write([]byte) (int, error)
	// Close used to close the LogFile
	Close() error
}

LogFile interface

type SizeRotateLogFile

type SizeRotateLogFile struct {
	BaseLogFile
	// contains filtered or unexported fields
}

SizeRotateLogFile structure definition A SizeRotateLogFile is a GZIP compressed file which rotates automatically

func OpenSizeRotateLogFile

func OpenSizeRotateLogFile(path string, perm os.FileMode, size int64) (*SizeRotateLogFile, error)

OpenSizeRotateLogFile opens a new log file for logging rotating according to its own size

func (*SizeRotateLogFile) RotRoutine

func (l *SizeRotateLogFile) RotRoutine()

RotRoutine implements LogFile

type TimeRotateLogFile

type TimeRotateLogFile struct {
	BaseLogFile
	// contains filtered or unexported fields
}

TimeRotateLogFile structure definition. A TimeRotateLogFile rotates at whenever rotation delay expires. The current file being used is in plain-text. Whenever the rotation happens, the file is GZIP-ed to save space on disk. A delay can be specified in order to wait before the file is compressed.

func OpenTimeRotateLogFile

func OpenTimeRotateLogFile(path string, perm os.FileMode, drot time.Duration) (l *TimeRotateLogFile, err error)

OpenTimeRotateLogFile opens a new TimeRotateLogFile drot controls the rotation delay and dgzip the time to wait before the latest file is GZIPed

func (*TimeRotateLogFile) Close

func (l *TimeRotateLogFile) Close() error

Close implements LogFile interface

func (*TimeRotateLogFile) RotRoutine

func (l *TimeRotateLogFile) RotRoutine()

RotRoutine implements LogFile