blackbox

Documentation

Index

• Variables
• type Arguments
  • func (a *Arguments) Convert() *blackbox_exporter.Config
  • func (a *Arguments) SetToDefault()
  • func (a *Arguments) Validate() error
• type BlackboxTarget
• type TargetBlock
  • func (t TargetBlock) Convert() []blackbox_exporter.BlackboxTarget

Variables

var DefaultArguments = Arguments{
	ProbeTimeoutOffset: 500 * time.Millisecond,
}

DefaultArguments holds non-zero default options for Arguments when it is unmarshaled from river.

Types

type Arguments

type Arguments struct {
	ConfigFile         string                    `river:"config_file,attr,optional"`
	Config             rivertypes.OptionalSecret `river:"config,attr,optional"`
	Targets            TargetBlock               `river:"target,block"`
	ProbeTimeoutOffset time.Duration             `river:"probe_timeout_offset,attr,optional"`
	ConfigStruct       blackbox_config.Config
}

func (*Arguments) Convert

func (a *Arguments) Convert() *blackbox_exporter.Config

Convert converts the component's Arguments to the integration's Config.

func (*Arguments) SetToDefault

func (a *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

func (*Arguments) Validate

func (a *Arguments) Validate() error

Validate implements river.Validator.

type BlackboxTarget

type BlackboxTarget struct {
	Name   string            `river:",label"`
	Target string            `river:"address,attr"`
	Module string            `river:"module,attr,optional"`
	Labels map[string]string `river:"labels,attr,optional"`
}

BlackboxTarget defines a target to be used by the exporter.

type TargetBlock

type TargetBlock []BlackboxTarget

func (TargetBlock) Convert

func (t TargetBlock) Convert() []blackbox_exporter.BlackboxTarget

Convert converts the component's TargetBlock to a slice of integration's BlackboxTarget.