file

Documentation

Index

• type Tailer
  • func NewTailer(path string, idleDuration time.Duration) (*Tailer, error)
  • func (t *Tailer) Next() ([]byte, error)
• type TailerT

Types

type Tailer

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

Tailer is an abstraction for reading newly appended content from a file, implementing TailerT (i.e. returning newly appended bytes on calls to Next()). After idleDuration of file inactivity (no new content), calls to Next() also invoke a rotation check.

func NewTailer

func NewTailer(path string, idleDuration time.Duration) (*Tailer, error)

NewTailer creates a new Tailer object configured to read data from the file at the supplied path (and performing rotation checks after idleDuration of inactivity).

func (*Tailer) Next

func (t *Tailer) Next() ([]byte, error)

Next will return content newly read from the log file. If no new content is available, and this condition has persisted for at least the idleDuration, a rotation check will be performed.

type TailerT

type TailerT interface {
	Next() ([]byte, error)
}

TailerT is an interface representing a Tailer (useful for mocks).