tailer

package
v3.0.0-rc13+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 22, 2018 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package tailer provides a class that is responsible for tailing log files and extracting new log lines to be passed into the virtual machines.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func OneShot

func OneShot(t *Tailer) error

OneShot puts the tailer in one-shot mode.

Types

type LogLine

type LogLine struct {
	Filename string // The log filename that this line was read from
	Line     string // The text of the log line itself up to the newline.
}

LogLine contains all the information about a line just read from a log.

func NewLogLine

func NewLogLine(filename string, line string) *LogLine

NewLogLine creates a new LogLine object.

type Tailer

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

Tailer receives notification of changes from a Watcher and extracts new log lines from files. It also handles new log file creation events and log rotations.

func New

func New(lines chan<- *LogLine, fs afero.Fs, w watcher.Watcher, options ...func(*Tailer) error) (*Tailer, error)

New creates a new Tailer.

func (*Tailer) Close

func (t *Tailer) Close() error

Close signals termination to the watcher.

func (*Tailer) SetOption

func (t *Tailer) SetOption(options ...func(*Tailer) error) error

SetOption takes one or more option functions and applies them in order to Tailer.

func (*Tailer) TailHandle

func (t *Tailer) TailHandle(f afero.File) error

TailHandle registers a file handle to be tailed. There is no filesystem to watch, so no watches are registered, and no file paths are opened.

func (*Tailer) TailPath

func (t *Tailer) TailPath(pathname string) error

TailPath registers a filesystem pathname to be tailed.

func (*Tailer) TailPattern

func (t *Tailer) TailPattern(pattern string) error

TailPattern registers a pattern to be tailed. If pattern is a plain file then it is watched for updates and opened. If pattern is a glob, then all paths that match the glob are opened and watched, and the directories containing those matches, if any, are watched.

func (*Tailer) WriteStatusHTML

func (t *Tailer) WriteStatusHTML(w io.Writer) error

WriteStatusHTML emits the Tailer's state in HTML format to the io.Writer w.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL