sources

Documentation

Index

• Constants
• func CommentMatchedLine() func(matchedLine string) string
• type CommentFunc
• type Event
• type FindFunc
• type FindResult
  • func SelectMatches(results []FindResult, matchSelector string) []FindResult
• type LogReader
  • func (l *LogReader) ClearCache()
  • func (l *LogReader) Find(re *regexp.Regexp) ([]string, error)
  • func (l *LogReader) ParseTimestamp(line string) (time.Time, error)
  • func (l *LogReader) Read() ([]byte, error)
• type Source
• type Timing

Constants

const (
	EventMatchSelectorFirst = "first"
	EventMatchSelectorLast  = "last"
	EventMatchSelectorAll   = "all"
)

Match Selector consts for an Event's MatchSelector

Functions

func CommentMatchedLine

func CommentMatchedLine() func(matchedLine string) string

CommentMatchedLine is a helper func that returns a func that can be used as a CommentFunc in an Event The func will use the matched line as the comment

Types

type CommentFunc

type CommentFunc func(matchedLine string) string

type Event

type Event struct {
	Name          string      `json:"name"`
	Metric        string      `json:"metric"`
	MatchSelector string      `json:"matchSelector"`
	Terminal      bool        `json:"terminal"`
	SrcName       string      `json:"src"`
	Src           Source      `json:"-"`
	CommentFn     CommentFunc `json:"-"`
	FindFn        FindFunc    `json:"-"`
}

Event defines what is being timed from a specific source

type FindFunc

type FindFunc func(s Source, log []byte) ([]string, error)

type FindResult

type FindResult struct {
	Line      string
	Timestamp time.Time
	Comment   string
	Err       error
}

FindResult is all data associated with a find including the raw Line data

func SelectMatches

func SelectMatches(results []FindResult, matchSelector string) []FindResult

SelectMaches will filter raw results based on the provided matchSelector

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) ([]string, error)

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

func (*LogReader) ParseTimestamp

func (l *LogReader) ParseTimestamp(line string) (time.Time, error)

ParseTimestamp usese the configured timestamp regex to find a timestamp from the passed in log line and return as a time.Time

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(event *Event) ([]FindResult, 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 is an interface representing a source of events which have a time stamp or latency associated with them. Most often source is a log file or an API.

type Timing

type Timing struct {
	Event     *Event        `json:"event"`
	Timestamp time.Time     `json:"timestamp"`
	T         time.Duration `json:"seconds"`
	Comment   string        `json:"comment"`
	Error     error         `json:"error"`
}

Timing is a specific instance of an Event timing