filewatch

Documentation

Index

• Constants
• Variables
• type Action
  • func New(config *common.Config, files []*WatchFile, ignored []string) *Action
  • func (a *Action) AddFileWatcher(file *WatchFile) error
  • func (a *Action) Files() []*WatchFile
  • func (a *Action) Run(_ context.Context)
  • func (a *Action) Stop()
• type Match
• type WatchFile
  • func (w *WatchFile) Active() bool
  • func (w *WatchFile) Stop() error

Constants

const (
	Errors  = " Errors"
	Matched = " Matched"
)

Variables

var (
	ErrInvalidRegexp = errors.New("invalid regexp")
	ErrIgnoredLog    = errors.New("the requested path is internally ignored")
)

Types

type Action

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

Action contains the exported methods for this package.

func New

func New(config *common.Config, files []*WatchFile, ignored []string) *Action

New configures the library.

func (*Action) AddFileWatcher

func (a *Action) AddFileWatcher(file *WatchFile) error

func (*Action) Files

func (a *Action) Files() []*WatchFile

Files returns the list of files configured.

func (*Action) Run

func (a *Action) Run(_ context.Context)

Run compiles any regexp's and opens a tail -f on provided watch files.

func (*Action) Stop

func (a *Action) Stop()

Stop all file watcher routines.

type Match

type Match struct {
	File    string   `json:"file"`
	Matches []string `json:"matches"`
	Line    string   `json:"line"`
}

Match is what we send to the website.

type WatchFile

type WatchFile struct {
	Path      string `json:"path"      toml:"path"       xml:"path"       yaml:"path"`
	Regexp    string `json:"regex"     toml:"regex"      xml:"regex"      yaml:"regex"`
	Skip      string `json:"skip"      toml:"skip"       xml:"skip"       yaml:"skip"`
	Poll      bool   `json:"poll"      toml:"poll"       xml:"poll"       yaml:"poll"`
	Pipe      bool   `json:"pipe"      toml:"pipe"       xml:"pipe"       yaml:"pipe"`
	MustExist bool   `json:"mustExist" toml:"must_exist" xml:"must_exist" yaml:"mustExist"`
	LogMatch  bool   `json:"logMatch"  toml:"log_match"  xml:"log_match"  yaml:"logMatch"`
	// contains filtered or unexported fields
}

WatchFile is the input data needed to watch files.

func (*WatchFile) Active

func (w *WatchFile) Active() bool

Active returns true if the tail channel is still open.

func (*WatchFile) Stop

func (w *WatchFile) Stop() error