prober

Documentation

Index

• Variables
• type Manager
  • func NewManager(recorder record.EventRecorder) Manager

Variables

var ProberResults = metrics.NewCounterVec(
	&metrics.CounterOpts{
		Subsystem:      "prober",
		Name:           "probe_total",
		Help:           "Cumulative number of a readiness probe for a thirdcomponent endpoint by result.",
		StabilityLevel: metrics.ALPHA,
	},
	[]string{"result",
		"endpoint",
		"thirdcomponent",
		"namespace"},
)

ProberResults stores the cumulative number of a probe by result as prometheus metrics.

Types

type Manager

type Manager interface {
	// AddThirdComponent creates new probe workers for every endpoint address probe.
	AddThirdComponent(thirdComponent *v1alpha1.ThirdComponent)

	// GetResult returns the probe result based on the given ID.
	GetResult(endpointID string) (results.Result, bool)

	Stop()

	// Updates creates a channel that receives an Update whenever its result changes (but not
	// removed).
	// NOTE: The current implementation only supports a single updates channel.
	Updates() <-chan results.Update
}

Manager manages thirdcomponent probing. It creates a probe "worker" for every endpoint address that specifies a probe (AddThirdComponent). The worker periodically probes its assigned endpoint address and caches the results. The manager use the cached probe results to set the appropriate Ready state in the ThirdComponentEndpointStatus when requested (ThirdComponentEndpointStatus). Updating probe parameters is not currently supported.

func NewManager

func NewManager(
	recorder record.EventRecorder) Manager

NewManager creates a Manager for pod probing.