exporter

Documentation

Index

• func New(creator Creator, name string) func(component.Options, component.Arguments) (component.Component, error)
• func NewWithTargetBuilder(creator Creator, name string, ...) func(component.Options, component.Arguments) (component.Component, error)
• func RequiredServices(additionalServices ...string) []string
• type Component
  • func (c *Component) Handler() http.Handler
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error
• type Creator
• type Exports

Functions

func New

func New(creator Creator, name string) func(component.Options, component.Arguments) (component.Component, error)

New creates a new exporter component.

func NewWithTargetBuilder

func NewWithTargetBuilder(creator Creator, name string, targetBuilderFunc func(discovery.Target, component.Arguments) []discovery.Target) func(component.Options, component.Arguments) (component.Component, error)

NewWithTargetBuilder creates a new exporter component with a custom target builder function. It can be used to expand a set of targets from a single one, or to customize the labels of the targets.

func RequiredServices

func RequiredServices(additionalServices ...string) []string

RequiredServices returns the set of services needed by all prometheus.exporter components. Callers may optionally pass in additional services to add to the returned list.

Types

type Component

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

func (*Component) Handler

func (c *Component) Handler() http.Handler

Handler serves metrics endpoint from the integration implementation.

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.Component.

type Creator

type Creator func(component.Options, component.Arguments, string) (integrations.Integration, string, error)

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

type Exports

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

Exports are simply a list of targets for a scraper to consume.