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
• type TargetsList
  • func (t TargetsList) 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 Alloy.

Types

type Arguments

type Arguments struct {
	ConfigFile         string                    `alloy:"config_file,attr,optional"`
	Config             alloytypes.OptionalSecret `alloy:"config,attr,optional"`
	Targets            TargetBlock               `alloy:"target,block,optional"`
	ProbeTimeoutOffset time.Duration             `alloy:"probe_timeout_offset,attr,optional"`

	// New way of passing targets. This allows the component to receive targets from other components.
	TargetsList TargetsList `alloy:"targets,attr,optional"`
}

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 syntax.Defaulter.

func (*Arguments) Validate

func (a *Arguments) Validate() error

Validate implements syntax.Validator.

type BlackboxTarget

type BlackboxTarget struct {
	Name   string            `alloy:"name,attr"`
	Target string            `alloy:"address,attr"`
	Module string            `alloy:"module,attr,optional"`
	Labels map[string]string `alloy:"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.

type TargetsList

type TargetsList []map[string]string

func (TargetsList) Convert

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