options

Documentation

Overview

Package options provides a shared interface to common probe options.

Index

• type AdditionalLabel
  • func ParseAdditionalLabel(alpb *configpb.AdditionalLabel) *AdditionalLabel
  • func (al *AdditionalLabel) KeyValueForTarget(ep endpoint.Endpoint) (key, val string)
  • func (al *AdditionalLabel) UpdateForTarget(ep endpoint.Endpoint, ipAddr string, probePort int)
• type Options
  • func BuildProbeOptions(p *configpb.ProbeDef, ldLister endpoint.Lister, ...) (*Options, error)
  • func DefaultOptions() *Options
  • func (opts *Options) IsScheduled() bool
  • func (opts *Options) RecordMetrics(ep endpoint.Endpoint, em *metrics.EventMetrics, ...)
• type RecordOptions
  • func WithNoAlert() RecordOptions
• type Schedule
  • func NewSchedule(scheds []*configpb.Schedule, l *logger.Logger) (*Schedule, error)

Types

type AdditionalLabel

type AdditionalLabel struct {
	Key string
	// contains filtered or unexported fields
}

AdditionalLabel encapsulates additional labels to attach to probe results.

func ParseAdditionalLabel

func ParseAdditionalLabel(alpb *configpb.AdditionalLabel) *AdditionalLabel

ParseAdditionalLabel parses an additional label proto message into an AdditionalLabel struct.

func (*AdditionalLabel) KeyValueForTarget

func (al *AdditionalLabel) KeyValueForTarget(ep endpoint.Endpoint) (key, val string)

KeyValueForTarget returns key, value pair for the given target.

func (*AdditionalLabel) UpdateForTarget

func (al *AdditionalLabel) UpdateForTarget(ep endpoint.Endpoint, ipAddr string, probePort int)

UpdateForTarget updates addtional label based on target's name and labels.

type Options

type Options struct {
	Targets             targets.Targets
	Interval, Timeout   time.Duration
	Logger              *logger.Logger
	ProbeConf           interface{} // Probe-type specific config
	LatencyDist         *metrics.Distribution
	LatencyUnit         time.Duration
	LatencyMetricName   string
	Validators          []*validators.Validator
	SourceIP            net.IP
	IPVersion           int
	StatsExportInterval time.Duration
	LogMetrics          func(*metrics.EventMetrics)
	AdditionalLabels    []*AdditionalLabel
	Schedule            *Schedule
	NegativeTest        bool
	AlertHandlers       []*alerting.AlertHandler
}

Options encapsulates common probe options.

func BuildProbeOptions

func BuildProbeOptions(p *configpb.ProbeDef, ldLister endpoint.Lister, globalTargetsOpts *targetspb.GlobalTargetsOptions, l *logger.Logger) (*Options, error)

BuildProbeOptions builds probe's options using the provided config and some global params.

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns default options, capturing default values for the various fields.

func (*Options) IsScheduled

func (opts *Options) IsScheduled() bool

func (*Options) RecordMetrics

func (opts *Options) RecordMetrics(ep endpoint.Endpoint, em *metrics.EventMetrics, dataChan chan<- *metrics.EventMetrics, ropts ...RecordOptions)

type RecordOptions

type RecordOptions func(*recordOptions)

func WithNoAlert

func WithNoAlert() RecordOptions

type Schedule

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

func NewSchedule

func NewSchedule(scheds []*configpb.Schedule, l *logger.Logger) (*Schedule, error)