integrations

Documentation

Index

• Variables
• func MarshalYAML(v interface{}) (interface{}, error)
• func RegisterIntegration(cfg Config)
• func UnmarshalYAML(out interface{}, unmarshal func(interface{}) error) error
• type CollectorIntegration
  • func NewCollectorIntegration(name string, configs ...CollectorIntegrationConfig) *CollectorIntegration
  • func (i *CollectorIntegration) MetricsHandler() (http.Handler, error)
  • func (i *CollectorIntegration) Run(ctx context.Context) error
  • func (i *CollectorIntegration) ScrapeConfigs() []config.ScrapeConfig
• type CollectorIntegrationConfig
  • func WithCollectors(cs ...prometheus.Collector) CollectorIntegrationConfig
  • func WithExporterMetricsIncluded(included bool) CollectorIntegrationConfig
  • func WithRunner(runner func(context.Context) error) CollectorIntegrationConfig
• type Config
• type Configs
  • func (c *Configs) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Integration
• type Manager
  • func NewManager(c ManagerConfig, logger log.Logger, im instance.Manager, ...) (*Manager, error)
  • func (m *Manager) ApplyConfig(cfg ManagerConfig) error
  • func (m *Manager) Stop()
  • func (m *Manager) WireAPI(r *mux.Router)
• type ManagerConfig
  • func (c *ManagerConfig) ApplyDefaults(cfg *prom.Config) error
  • func (c *ManagerConfig) DefaultRelabelConfigs(hostname string) []*relabel.Config
  • func (c ManagerConfig) MarshalYAML() (interface{}, error)
  • func (c *ManagerConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var DefaultManagerConfig = ManagerConfig{
	ScrapeIntegrations:        true,
	IntegrationRestartBackoff: 5 * time.Second,
	UseHostnameLabel:          true,
	ReplaceInstanceLabel:      true,
}

DefaultManagerConfig holds the default settings for integrations.

Functions

func MarshalYAML

func MarshalYAML(v interface{}) (interface{}, error)

MarshalYAML helps implement yaml.Marshaller for structs that have a Configs field that should be inlined in the YAML string.

func RegisterIntegration

func RegisterIntegration(cfg Config)

RegisterIntegration dynamically registers a new integration. The Config will represent the configuration that controls the specific integration. Registered Configs may be loaded using UnmarshalYAML or manually constructed.

RegisterIntegration panics if cfg is not a pointer.

func UnmarshalYAML

func UnmarshalYAML(out interface{}, unmarshal func(interface{}) error) error

UnmarshalYAML helps implement yaml.Unmarshaller for structs that have a Configs field that should be inlined in the YAML string.

Types

type CollectorIntegration

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

CollectorIntegration is an integration exposing metrics from one or more Prometheus collectors.

func NewCollectorIntegration

func NewCollectorIntegration(name string, configs ...CollectorIntegrationConfig) *CollectorIntegration

NewCollectorIntegration creates a basic integration that exposes metrics from multiple prometheus.Collector.

func (*CollectorIntegration) MetricsHandler

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

MetricsHandler returns the HTTP handler for the integration.

func (*CollectorIntegration) Run

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

Run satisfies Integration.Run.

func (*CollectorIntegration) ScrapeConfigs

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

ScrapeConfigs satisfies Integration.ScrapeConfigs.

type CollectorIntegrationConfig

type CollectorIntegrationConfig func(integration *CollectorIntegration)

CollectorIntegrationConfig defines constructor configuration for NewCollectorIntegration

func WithCollectors

func WithCollectors(cs ...prometheus.Collector) CollectorIntegrationConfig

WithCollectors adds more collectors to the CollectorIntegration being created.

func WithExporterMetricsIncluded

func WithExporterMetricsIncluded(included bool) CollectorIntegrationConfig

WithExporterMetricsIncluded can enable the exporter metrics if the flag provided is enabled.

func WithRunner

func WithRunner(runner func(context.Context) error) CollectorIntegrationConfig

WithRunner replaces the runner of the CollectorIntegration. The runner function should run while the context provided is not done.

type Config

type Config interface {
	// Name returns the name of the integration and the key that will be used to
	// pull the configuration from the Agent config YAML.
	Name() string

	// CommonConfig returns the set of common configuration values present across
	// all integrations.
	CommonConfig() config.Common

	// NewIntegration returns an integration for the given with the given logger.
	NewIntegration(l log.Logger) (Integration, error)
}

Config provides the configuration and constructor for an integration.

type Configs

type Configs []Config

Configs is a list of integrations.

func (*Configs) UnmarshalYAML

func (c *Configs) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type Integration

type Integration interface {
	// MetricsHandler returns an http.Handler that will return metrics.
	MetricsHandler() (http.Handler, error)

	// ScrapeConfigs returns a set of scrape configs that determine where metrics
	// can be scraped.
	ScrapeConfigs() []config.ScrapeConfig

	// Run should start the integration and do any required tasks, if necessary.
	// For example, an Integration that requires a persistent connection to a
	// database would establish that connection here. If the integration doesn't
	// need to do anything, it should wait for the ctx to be canceled.
	Run(ctx context.Context) error
}

An Integration is a process that integrates with some external system and pulls telemetry data.

type Manager

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

Manager manages a set of integrations and runs them.

func NewManager

func NewManager(c ManagerConfig, logger log.Logger, im instance.Manager, validate configstore.Validator) (*Manager, error)

NewManager creates a new integrations manager. NewManager must be given an InstanceManager which is responsible for accepting instance configs to scrape and send metrics from running integrations.

func (*Manager) ApplyConfig

func (m *Manager) ApplyConfig(cfg ManagerConfig) error

ApplyConfig updates the configuration of the integrations subsystem.

func (*Manager) Stop

func (m *Manager) Stop()

Stop stops the manager and all of its integrations. Blocks until all running integrations exit.

func (*Manager) WireAPI

func (m *Manager) WireAPI(r *mux.Router)

WireAPI hooks up /metrics routes per-integration.

type ManagerConfig

type ManagerConfig struct {
	// When true, scrapes metrics from integrations.
	ScrapeIntegrations bool `yaml:"scrape_integrations,omitempty"`
	// When true, replaces the instance label with the agent hostname.
	ReplaceInstanceLabel bool `yaml:"replace_instance_label,omitempty"`

	// DEPRECATED. When true, adds an agent_hostname label to all samples from integrations.
	// ReplaceInstanceLabel should be used instead.
	UseHostnameLabel bool `yaml:"use_hostname_label,omitempty"`

	// The integration configs is merged with the manager config struct so we
	// don't want to export it here; we'll manually unmarshal it in UnmarshalYAML.
	Integrations Configs `yaml:"-"`

	// Extra labels to add for all integration samples
	Labels model.LabelSet `yaml:"labels,omitempty"`

	// Prometheus RW configs to use for all integrations.
	PrometheusRemoteWrite []*config.RemoteWriteConfig `yaml:"prometheus_remote_write,omitempty"`

	IntegrationRestartBackoff time.Duration `yaml:"integration_restart_backoff,omitempty"`

	// ListenPort tells the integration Manager which port the Agent is
	// listening on for generating Prometheus instance configs.
	ListenPort int `yaml:"-"`

	// ListenHost tells the integration Manager which port the Agent is
	// listening on for generating Prometheus instance configs
	ListenHost string `yaml:"-"`

	TLSConfig config_util.TLSConfig `yaml:"http_tls_config,omitempty"`

	// This is set to true if the Server TLSConfig Cert and Key path are set
	ServerUsingTLS bool `yaml:"-"`
}

ManagerConfig holds the configuration for all integrations.

func (*ManagerConfig) ApplyDefaults

func (c *ManagerConfig) ApplyDefaults(cfg *prom.Config) error

ApplyDefaults applies default settings to the ManagerConfig and validates that it can be used.

If any integrations are enabled and are configured to be scraped, the Prometheus configuration must have a WAL directory configured.

func (*ManagerConfig) DefaultRelabelConfigs

func (c *ManagerConfig) DefaultRelabelConfigs(hostname string) []*relabel.Config

DefaultRelabelConfigs returns the set of relabel configs that should be prepended to all RelabelConfigs for an integration.

func (ManagerConfig) MarshalYAML

func (c ManagerConfig) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler for ManagerConfig.

func (*ManagerConfig) UnmarshalYAML

func (c *ManagerConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler for ManagerConfig.