exporter

Documentation

Index

• Constants
• Variables
• func BufferedTailerWithMetrics(orig tailer.Tailer) tailer.Tailer
• func RunHttpServer(host string, port int, path string, handler http.Handler) error
• func RunHttpsServer(host string, port int, cert, key, path string, handler http.Handler) error
• func RunHttpsServerWithDefaultKeys(host string, port int, path string, handler http.Handler) error
• func VerifyFieldNames(m *v2.MetricConfig, regex, deleteRegex *OnigurumaRegexp) error
• func VersionString() string
• type LabelValueTracker
  • func NewLabelValueTracker(labelNames []string) LabelValueTracker
• type Match
• type Metric
  • func NewCounterMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, ...) Metric
  • func NewGaugeMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, ...) Metric
  • func NewHistogramMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, ...) Metric
  • func NewSummaryMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, ...) Metric
• type OnigurumaLib
  • func InitOnigurumaLib() (*OnigurumaLib, error)
  • func (o *OnigurumaLib) Compile(pattern string) (*OnigurumaRegexp, error)
  • func (o *OnigurumaLib) Version() string
• type OnigurumaMatchResult
  • func (m *OnigurumaMatchResult) Free()
  • func (m *OnigurumaMatchResult) Get(name string) (string, error)
  • func (m *OnigurumaMatchResult) IsMatch() bool
• type OnigurumaRegexp
  • func Compile(pattern string, patterns *Patterns, libonig *OnigurumaLib) (*OnigurumaRegexp, error)
  • func (regex *OnigurumaRegexp) Free()
  • func (regex *OnigurumaRegexp) HasCaptureGroup(name string) bool
  • func (regex *OnigurumaRegexp) Match(input string) (*OnigurumaMatchResult, error)
• type Patterns
  • func InitPatterns() *Patterns
  • func (p *Patterns) AddDir(path string) error
  • func (p *Patterns) AddFile(path string) error
  • func (p *Patterns) AddPattern(pattern string) error
  • func (p *Patterns) Find(pattern string) (string, bool)

Constants

const PATTERN_RE = `%{(.+?)}`

PATTERN_RE matches the %{..} patterns. There are three possibilities: 1) %{USER} - grok pattern 2) %{IP:clientip} - grok pattern with name 3) %{INT:clientport:int} - grok pattern with name and type (type is currently ignored)

Variables

var (
	Version   string
	BuildDate string
	Branch    string
	Revision  string
	GoVersion = runtime.Version()
	Platform  = runtime.GOOS + "-" + runtime.GOARCH
)

The following strings are populated during build time with release.sh: go build -ldflags "-X importpath.name=value"

var (
	// See the #define statements in oniguruma.h
	ONIG_ENCODING_UTF8 = &C.OnigEncodingUTF8
)

Functions

func BufferedTailerWithMetrics

func BufferedTailerWithMetrics(orig tailer.Tailer) tailer.Tailer

Wrapper around a tailer that consumes the lines channel quickly. The idea is that the original tailer can continue reading lines from the logfile, and does not need to wait until the lines are processed. The number of buffered lines are exposed as a Prometheus metric, if lines are constantly produced faster than they are consumed, we will eventually run out of memory.

func RunHttpServer

func RunHttpServer(host string, port int, path string, handler http.Handler) error

func RunHttpsServer

func RunHttpsServer(host string, port int, cert, key, path string, handler http.Handler) error

func RunHttpsServerWithDefaultKeys

func RunHttpsServerWithDefaultKeys(host string, port int, path string, handler http.Handler) error

func VerifyFieldNames

func VerifyFieldNames(m *v2.MetricConfig, regex, deleteRegex *OnigurumaRegexp) error

func VersionString

func VersionString() string

Types

type LabelValueTracker

type LabelValueTracker interface {
	Observe(labels map[string]string) (bool, error)
	DeleteByLabels(labels map[string]string) ([]map[string]string, error)
	DeleteByRetention(retention time.Duration) []map[string]string
}

Keep track of labels values for a metric.

func NewLabelValueTracker

func NewLabelValueTracker(labelNames []string) LabelValueTracker

type Match

type Match struct {
	Labels map[string]string
	Value  float64
}

type Metric

type Metric interface {
	Name() string
	Collector() prometheus.Collector

	// Returns the match if the line matched, and nil if the line didn't match.
	ProcessMatch(line string) (*Match, error)
	// Returns the match if the delete pattern matched, nil otherwise.
	ProcessDeleteMatch(line string) (*Match, error)
	// Remove old metrics
	ProcessRetention() error
}

func NewCounterMetric

func NewCounterMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, deleteRegex *OnigurumaRegexp) Metric

func NewGaugeMetric

func NewGaugeMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, deleteRegex *OnigurumaRegexp) Metric

func NewHistogramMetric

func NewHistogramMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, deleteRegex *OnigurumaRegexp) Metric

func NewSummaryMetric

func NewSummaryMetric(cfg *configuration.MetricConfig, regex *OnigurumaRegexp, deleteRegex *OnigurumaRegexp) Metric

type OnigurumaLib

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

func InitOnigurumaLib

func InitOnigurumaLib() (*OnigurumaLib, error)

Warning: The Oniguruma library is not thread save, it should be used in a single thread.

func (*OnigurumaLib) Compile

func (o *OnigurumaLib) Compile(pattern string) (*OnigurumaRegexp, error)

func (*OnigurumaLib) Version

func (o *OnigurumaLib) Version() string

type OnigurumaMatchResult

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

func (*OnigurumaMatchResult) Free

func (m *OnigurumaMatchResult) Free()

func (*OnigurumaMatchResult) Get

func (m *OnigurumaMatchResult) Get(name string) (string, error)

func (*OnigurumaMatchResult) IsMatch

func (m *OnigurumaMatchResult) IsMatch() bool

type OnigurumaRegexp

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

func Compile

func Compile(pattern string, patterns *Patterns, libonig *OnigurumaLib) (*OnigurumaRegexp, error)

Compile a grok pattern string into a regular expression.

func (*OnigurumaRegexp) Free

func (regex *OnigurumaRegexp) Free()

func (*OnigurumaRegexp) HasCaptureGroup

func (regex *OnigurumaRegexp) HasCaptureGroup(name string) bool

func (*OnigurumaRegexp) Match

func (regex *OnigurumaRegexp) Match(input string) (*OnigurumaMatchResult, error)

type Patterns

type Patterns map[string]string

func InitPatterns

func InitPatterns() *Patterns

func (*Patterns) AddDir

func (p *Patterns) AddDir(path string) error

func (*Patterns) AddFile

func (p *Patterns) AddFile(path string) error

pattern files see https://github.com/logstash-plugins/logstash-patterns-core/tree/master/patterns

func (*Patterns) AddPattern

func (p *Patterns) AddPattern(pattern string) error

func (*Patterns) Find

func (p *Patterns) Find(pattern string) (string, bool)