http

README

HTTP Input Plugin

The HTTP input plugin collects metrics from one or more HTTP(S) endpoints. The endpoint should have metrics formatted in one of the supported input data formats. Each data format has its own unique set of configuration options which can be added to the input configuration.

Configuration:

# Read formatted metrics from one or more HTTP endpoints
[[inputs.http]]
  ## One or more URLs from which to read formatted metrics
  urls = [
    "http://localhost/metrics"
  ]

  ## HTTP method
  # method = "GET"

  ## Optional HTTP headers
  # headers = {"X-Special-Header" = "Special-Value"}

  ## HTTP entity-body to send with POST/PUT requests.
  # body = ""

  ## HTTP Content-Encoding for write request body, can be set to "gzip" to
  ## compress body or "identity" to apply no encoding.
  # content_encoding = "identity"

  ## Optional file with Bearer token
  ## file content is added as an Authorization header
  # bearer_token = "/path/to/file"

  ## Optional HTTP Basic Auth Credentials
  # username = "username"
  # password = "pa$$word"

  ## HTTP Proxy support
  # http_proxy_url = ""
  
  ## Optional TLS Config
  # tls_ca = "/etc/circonus-unified-agent/ca.pem"
  # tls_cert = "/etc/circonus-unified-agent/cert.pem"
  # tls_key = "/etc/circonus-unified-agent/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Amount of time allowed to complete the HTTP request
  # timeout = "5s"

  ## List of success status codes
  # success_status_codes = [200]

  ## Data format to consume.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/circonus-labs/circonus-unified-agent/blob/master/docs/DATA_FORMATS_INPUT.md
  # data_format = "influx"

Metrics:

The metrics collected by this input plugin will depend on the configured data_format and the payload returned by the HTTP endpoint(s).

The default values below are added if the input format does not specify a value:

• http
  • tags:
    • url

Documentation

Index

• type HTTP
  • func (*HTTP) Description() string
  • func (h *HTTP) Gather(ctx context.Context, acc cua.Accumulator) error
  • func (h *HTTP) Init() error
  • func (*HTTP) SampleConfig() string
  • func (h *HTTP) SetParser(parser parsers.Parser)

Types

type HTTP

type HTTP struct {
	URLs            []string `toml:"urls"`
	Method          string   `toml:"method"`
	Body            string   `toml:"body"`
	ContentEncoding string   `toml:"content_encoding"`

	Headers map[string]string `toml:"headers"`

	// HTTP Basic Auth Credentials
	Username string `toml:"username"`
	Password string `toml:"password"`
	tls.ClientConfig

	proxy.HTTPProxy

	// Absolute path to file with Bearer token
	BearerToken string `toml:"bearer_token"`

	SuccessStatusCodes []int `toml:"success_status_codes"`

	Timeout internal.Duration `toml:"timeout"`
	// contains filtered or unexported fields
}

func (*HTTP) Description

func (*HTTP) Description() string

Description returns a one-sentence description on the Input

func (*HTTP) Gather

func (h *HTTP) Gather(ctx context.Context, acc cua.Accumulator) error

Gather takes in an accumulator and adds the metrics that the Input gathers. This is called every "interval"

func (*HTTP) Init

func (h *HTTP) Init() error

func (*HTTP) SampleConfig

func (*HTTP) SampleConfig() string

SampleConfig returns the default configuration of the Input

func (*HTTP) SetParser

func (h *HTTP) SetParser(parser parsers.Parser)

SetParser takes the data_format from the config and finds the right parser for that format