http

README

HTTP Output Plugin

This plugin sends metrics in a HTTP message encoded using one of the output data formats. For data_formats that support batching, metrics are sent in batch format.

Configuration:

# A plugin that can transmit metrics over HTTP
[[outputs.http]]
  ## URL is the address to send metrics to
  url = "http://127.0.0.1:8080/telegraf"

  ## Timeout for HTTP message
  # timeout = "5s"

  ## HTTP method, one of: "POST" or "PUT"
  # method = "POST"

  ## HTTP Basic Auth credentials
  # username = "username"
  # password = "pa$$word"

  ## OAuth2 Client Credentials Grant
  # client_id = "clientid"
  # client_secret = "secret"
  # token_url = "https://indentityprovider/oauth2/v1/token"
  # scopes = ["urn:opc:idm:__myscopes__"]

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Data format to output.
  ## Each data format has it's own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  # data_format = "influx"

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

  ## Additional HTTP headers
  # [outputs.http.headers]
  #   # Should be set manually to "application/json" for json data_format
  #   Content-Type = "text/plain; charset=utf-8"

Documentation

Index

• type HTTP
  • func (h *HTTP) Close() error
  • func (h *HTTP) Connect() error
  • func (h *HTTP) Description() string
  • func (h *HTTP) SampleConfig() string
  • func (h *HTTP) SetSerializer(serializer serializers.Serializer)
  • func (h *HTTP) Write(metrics []telegraf.Metric) error

Types

type HTTP

type HTTP struct {
	URL             string            `toml:"url"`
	Timeout         internal.Duration `toml:"timeout"`
	Method          string            `toml:"method"`
	Username        string            `toml:"username"`
	Password        string            `toml:"password"`
	Headers         map[string]string `toml:"headers"`
	ClientID        string            `toml:"client_id"`
	ClientSecret    string            `toml:"client_secret"`
	TokenURL        string            `toml:"token_url"`
	Scopes          []string          `toml:"scopes"`
	ContentEncoding string            `toml:"content_encoding"`
	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*HTTP) Close

func (h *HTTP) Close() error

func (*HTTP) Connect

func (h *HTTP) Connect() error

func (*HTTP) Description

func (h *HTTP) Description() string

func (*HTTP) SampleConfig

func (h *HTTP) SampleConfig() string

func (*HTTP) SetSerializer

func (h *HTTP) SetSerializer(serializer serializers.Serializer)

func (*HTTP) Write

func (h *HTTP) Write(metrics []telegraf.Metric) error