snmp

Documentation

Index

• type Arguments
  • func (a *Arguments) Convert() *snmp_exporter.Config
  • func (a *Arguments) UnmarshalAlloy(f func(interface{}) error) error
• type SNMPTarget
• type TargetBlock
  • func (t TargetBlock) Convert() []snmp_exporter.SNMPTarget
• type TargetsList
  • func (t TargetsList) Convert() []snmp_exporter.SNMPTarget
• type WalkParam
• type WalkParams
  • func (w WalkParams) Convert() map[string]snmp_config.WalkParams

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"`
	WalkParams   WalkParams                `alloy:"walk_param,block,optional"`
	ConfigStruct snmp_config.Config

	// 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() *snmp_exporter.Config

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

func (*Arguments) UnmarshalAlloy

func (a *Arguments) UnmarshalAlloy(f func(interface{}) error) error

UnmarshalAlloy implements Alloy unmarshalling for Arguments.

type SNMPTarget

type SNMPTarget struct {
	Name        string `alloy:",label"`
	Target      string `alloy:"address,attr"`
	Module      string `alloy:"module,attr,optional"`
	Auth        string `alloy:"auth,attr,optional"`
	WalkParams  string `alloy:"walk_params,attr,optional"`
	SNMPContext string `alloy:"snmp_context,attr,optional"`
}

SNMPTarget defines a target to be used by the exporter.

type TargetBlock

type TargetBlock []SNMPTarget

func (TargetBlock) Convert

func (t TargetBlock) Convert() []snmp_exporter.SNMPTarget

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

type TargetsList

type TargetsList []map[string]string

func (TargetsList) Convert

func (t TargetsList) Convert() []snmp_exporter.SNMPTarget

type WalkParam

type WalkParam struct {
	Name                    string        `alloy:",label"`
	MaxRepetitions          uint32        `alloy:"max_repetitions,attr,optional"`
	Retries                 int           `alloy:"retries,attr,optional"`
	Timeout                 time.Duration `alloy:"timeout,attr,optional"`
	UseUnconnectedUDPSocket bool          `alloy:"use_unconnected_udp_socket,attr,optional"`
}

type WalkParams

type WalkParams []WalkParam

func (WalkParams) Convert

func (w WalkParams) Convert() map[string]snmp_config.WalkParams

Convert converts the component's WalkParams to the integration's WalkParams.