sources

Documentation

Index

• type LogReader
  • func (l *LogReader) ClearCache()
  • func (l *LogReader) Find(re *regexp.Regexp, firstOccurrence bool) (time.Time, error)
  • func (l *LogReader) Read() ([]byte, error)
• type Source

Types

type LogReader

type LogReader struct {
	Path            string
	Glob            bool
	TimestampRegex  *regexp.Regexp
	TimestampLayout string
	// contains filtered or unexported fields
}

LogReader is a base Source helper that can Read file contents, cache, and support Glob file paths Other Sources can be built on-top of the LogSrc

func (*LogReader) ClearCache

func (l *LogReader) ClearCache()

ClearCache cleas the cached log

func (*LogReader) Find

func (l *LogReader) Find(re *regexp.Regexp, firstOccurrence bool) (time.Time, error)

Find searches for the passed in regexp from the log references in the LogReader

func (*LogReader) Read

func (l *LogReader) Read() ([]byte, error)

Read will open and read all the bytes of a log file into byte slice and then cache it Any further calls to Read() will use the cached byte slice. If the file is being updated and you need the updated contents, you'll need to instantiate a new LogSrc and call Read() again

type Source

type Source interface {
	// Find finds the string in the source using a source specific method (could be regex or HTTP path)
	// If no time.Time could be found an error is returned
	Find(search string, firstOccurrence bool) (time.Time, error)
	// Name is the source name identifier
	Name() string
	// ClearCache clears any cached source data
	ClearCache()
	// String is a human friendly version of the source, usually the log filepath
	String() string
}

Source ius