agent

Documentation

Overview

Package agent is an "example" integration that has very little functionality, but is still useful in practice. The Agent integration re-exposes the Agent's own metrics endpoint and allows the Agent to scrape itself.

Index

• type Config
• type Integration
  • func New(c Config) *Integration
  • func (i *Integration) CommonConfig() config.Common
  • func (i *Integration) Name() string
  • func (i *Integration) RegisterRoutes(r *mux.Router) error
  • func (i *Integration) Run(ctx context.Context) error
  • func (i *Integration) ScrapeConfigs() []config.ScrapeConfig

Types

type Config

type Config struct {
	CommonConfig config.Common `yaml:",inline"`

	// Enabled enables the Agent integration.
	Enabled bool
}

Config controls the Agent integration.

type Integration

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

Integration is the Agent integration. The Agent integration scrapes the Agent's own metrics.

func New

func New(c Config) *Integration

func (*Integration) CommonConfig

func (i *Integration) CommonConfig() config.Common

CommonConfig satisfies Integration.CommonConfig.

func (*Integration) Name

func (i *Integration) Name() string

Name satisfies Integration.Name.

func (*Integration) RegisterRoutes

func (i *Integration) RegisterRoutes(r *mux.Router) error

RegisterRoutes satisfies Integration.RegisterRoutes.

func (*Integration) Run

func (i *Integration) Run(ctx context.Context) error

Run satisfies Integration.Run.

func (*Integration) ScrapeConfigs

func (i *Integration) ScrapeConfigs() []config.ScrapeConfig

ScrapeConfigs satisfies Integration.ScrapeConfigs.