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 ValidateProbeConfig(p *configpb.ProbeDef) (*Options, error)
  • func (opts *Options) IsScheduled() bool
  • func (opts *Options) LogMetrics(em *metrics.EventMetrics)
  • func (opts *Options) RecordMetrics(ep endpoint.Endpoint, em *metrics.EventMetrics, ...)
  • func (opts *Options) StatsExportFrequency() int64
• 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 {
	Name                string
	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
	AdditionalLabels    []*AdditionalLabel
	Schedule            *Schedule
	NegativeTest        bool
	AlertHandlers       []*alerting.AlertHandler
	// TargetsUpdateInterval overrides the default scheduler target update
	// interval (1 minute). Set from probe's targets_update_sec if configured.
	TargetsUpdateInterval time.Duration
	// Prober config at the prober initialization time. This config is not
	// reliable for things that may change after initialization, e.g. probes
	// that can be added or removed through gRPC.
	ProberConfig *proberconfigpb.ProberConfig
	// contains filtered or unexported fields
}

Options encapsulates common probe options.

func BuildProbeOptions

func BuildProbeOptions(p *configpb.ProbeDef, ldLister endpoint.Lister, proberConfig *proberconfigpb.ProberConfig, 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 ValidateProbeConfig

func ValidateProbeConfig(p *configpb.ProbeDef) (*Options, error)

ValidateProbeConfig validates the probe configuration fields without creating targets or other resources, and returns a partial Options with the fields that can be derived from the proto config alone. This is used by ConfigTest to catch config errors like improperly formatted duration strings, and by BuildProbeOptions to avoid re-parsing the same fields.

func (*Options) IsScheduled

func (opts *Options) IsScheduled() bool

func (*Options) LogMetrics

func (opts *Options) LogMetrics(em *metrics.EventMetrics)

func (*Options) RecordMetrics

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

RecordMetrics updates EventMetrics with additional labels and pushes it to the data channel and alert handlers. It also logs EventMetrics if configured to do so in the options. Note: RecordMetrics doesn't clone the provided EventMetrics. It expects the caller to not modify it after calling this function.

func (*Options) StatsExportFrequency

func (opts *Options) StatsExportFrequency() int64

StatsExportFrequency returns how often to export metrics (in probe counts), initialized to statsExportInterval / p.opts.Interval. Metrics are exported when (runCnt % statsExportFrequency) == 0

type Schedule

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

func NewSchedule

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