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
  • func (c *Config) CommonConfig() config.Common
  • func (c *Config) Name() string
  • func (c *Config) NewIntegration(_ log.Logger) (integrations.Integration, error)
• type Integration
  • func New(c *Config) *Integration
  • func (i *Integration) MetricsHandler() (http.Handler, error)
  • func (i *Integration) Run(ctx context.Context) error
  • func (i *Integration) ScrapeConfigs() []config.ScrapeConfig

Types

type Config

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

Config controls the Agent integration.

func (*Config) CommonConfig

func (c *Config) CommonConfig() config.Common

CommonConfig returns the common settings shared across all integrations.

func (*Config) Name

func (c *Config) Name() string

Name returns the name of the integration that this config represents.

func (*Config) NewIntegration

func (c *Config) NewIntegration(_ log.Logger) (integrations.Integration, error)

NewIntegration converts this config into an instance of an 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

New creates a new Agent integration.

func (*Integration) MetricsHandler

func (i *Integration) MetricsHandler() (http.Handler, error)

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