discovery

Documentation

Index

• type Component
  • func New(o component.Options, args component.Arguments, creator Creator) (*Component, error)
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error
• type Creator
• type Discoverer
• type Exports
• type Target

Types

type Component

type Component struct {
	// contains filtered or unexported fields
}

Component is a reusable component for any discovery implementation. it will handle dynamic updates and exporting targets appropriately for a scrape implementation.

func New

func New(o component.Options, args component.Arguments, creator Creator) (*Component, error)

New creates a discovery component given arguments and a concrete Discovery implementation function.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run implements component.Component.

func (*Component) Update

func (c *Component) Update(args component.Arguments) error

Update implements component.Compnoent.

type Creator

type Creator func(component.Arguments) (Discoverer, error)

Creator is a function provided by an implementation to create a concrete Discoverer instance.

type Discoverer

type Discoverer discovery.Discoverer

Discoverer is an alias for Prometheus' Discoverer interface, so users of this package don't need to import github.com/prometheus/prometheus/discover as well.

type Exports

type Exports struct {
	Targets []Target `river:"targets,attr"`
}

Exports holds values which are exported by all discovery components.

type Target

type Target map[string]string

Target refers to a singular discovered endpoint found by a discovery component.