dockerstats

Documentation

Overview

Package dockerstats implements an OpenTelemetry receiver that periodically scrapes stats for docker containers from the docker API and expose them as metrics.

Index

• func NewFactory() component.ReceiverFactory
• type Config
• type Receiver
  • func (r *Receiver) Shutdown(ctx context.Context) error
  • func (r *Receiver) Start(ctx context.Context, host component.Host) error

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates and returns a factory for the docker stats receiver.

Types

type Config

type Config struct {
	config.ReceiverSettings `mapstructure:",squash"`
	// ScrapeInterval controls how often docker stats are scraped from docker API.
	ScrapeInterval time.Duration `mapstructure:"scrape_interval"`
}

Config defines the configuration for dockerstats receiver.

type Receiver

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

Receiver implements component.MetricReceiver. Manages the lifecycle of the scraper that scrapes docker stats from the API.

func (*Receiver) Shutdown

func (r *Receiver) Shutdown(ctx context.Context) error

Shutdown tells this receiver to stop.

func (*Receiver) Start

func (r *Receiver) Start(ctx context.Context, host component.Host) error

Start tells this receiver to start.