docker

Documentation

Overview

Package docker implements the discovery.docker component.

Index

• Variables
• func New(opts component.Options, args Arguments) (*discovery.Component, error)
• type Arguments
  • func (args Arguments) Convert() moby.DockerSDConfig
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type Filter
  • func (f Filter) Convert() moby.Filter

Variables

var DefaultArguments = Arguments{
	Port:               80,
	HostNetworkingHost: "localhost",
	RefreshInterval:    time.Minute,
	HTTPClientConfig:   config.DefaultHTTPClientConfig,
}

DefaultArguments holds default values for Arguments.

Functions

func New

func New(opts component.Options, args Arguments) (*discovery.Component, error)

New returns a new instance of a discovery.docker component.

Types

type Arguments

type Arguments struct {
	Host               string                  `river:"host,attr"`
	Port               int                     `river:"port,attr,optional"`
	HostNetworkingHost string                  `river:"host_networking_host,attr,optional"`
	RefreshInterval    time.Duration           `river:"refresh_interval,attr,optional"`
	Filters            []Filter                `river:"filter,block,optional"`
	HTTPClientConfig   config.HTTPClientConfig `river:",squash"`
}

Arguments configures the discovery.docker component.

func (Arguments) Convert

func (args Arguments) Convert() moby.DockerSDConfig

Convert converts Arguments to the upstream Prometheus SD type.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements river.Validator.

type Filter

type Filter struct {
	Name   string   `river:"name,attr"`
	Values []string `river:"values,attr"`
}

Filter is used to limit the discovery process to a subset of available resources.

func (Filter) Convert

func (f Filter) Convert() moby.Filter

Convert converts a Filter to the upstream Prometheus SD type.