options

Documentation

Overview

Package options provides a shared interface to common probe options.

Index

• type Options
  • func BuildProbeOptions(p *configpb.ProbeDef, ldLister lameduck.Lister, ...) (*Options, error)

Types

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
	Validators          []*validators.ValidatorWithName
	SourceIP            net.IP
	IPVersion           int
	StatsExportInterval time.Duration
	LogMetrics          func(*metrics.EventMetrics)
}

Options encapsulates common probe options.

func BuildProbeOptions

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

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