datadog

README

Datadog Output Plugin

This plugin writes metrics to the Datadog Metrics API and requires an apikey which can be obtained here for the account.

[!NOTE] This plugin supports the v1 API.

⭐ Telegraf v0.1.6 🏷️ applications, cloud, datastore 💻 all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Configuration for DataDog API to send metrics to.
[[outputs.datadog]]
  ## Datadog API key
  apikey = "my-secret-key"

  ## Connection timeout.
  # timeout = "5s"

  ## Write URL override; useful for debugging.
  ## This plugin only supports the v1 API currently due to the authentication
  ## method used.
  # url = "https://app.datadoghq.com/api/v1/series"

  ## Set http_proxy
  # use_system_proxy = false
  # http_proxy_url = "http://localhost:8888"

  ## Override the default (none) compression used to send data.
  ## Supports: "zlib", "none"
  # compression = "none"

  ## When non-zero, converts count metrics submitted by inputs.statsd
  ## into rate, while dividing the metric value by this number.
  ## Note that in order for metrics to be submitted simultaenously alongside
  ## a Datadog agent, rate_interval has to match the interval used by the
  ## agent - which defaults to 10s
  # rate_interval = 0s

Metrics

Datadog metric names are formed by joining the Telegraf metric name and the field key with a . character.

Field values are converted to floating point numbers. Strings and floats that cannot be sent over JSON, namely NaN and Inf, are ignored.

Setting rate_interval to non-zero will convert count metrics to rate and divide its value by this interval before submitting to Datadog. This allows Telegraf to submit metrics alongside Datadog agents when their rate intervals are the same (Datadog defaults to 10s). Note that this only supports metrics ingested via inputs.statsd given the dependency on the metric_type tag it creates. There is only support for counter metrics, and count values from timing and histogram metrics.

Documentation

Index

• type Datadog
  • func (*Datadog) Close() error
  • func (d *Datadog) Connect() error
  • func (*Datadog) SampleConfig() string
  • func (d *Datadog) Write(metrics []telegraf.Metric) error
• type Metric
• type Point
• type TimeSeries

Types

type Datadog

type Datadog struct {
	Apikey       string          `toml:"apikey"`
	Timeout      config.Duration `toml:"timeout"`
	URL          string          `toml:"url"`
	Compression  string          `toml:"compression"`
	RateInterval config.Duration `toml:"rate_interval"`
	Log          telegraf.Logger `toml:"-"`

	proxy.HTTPProxy
	// contains filtered or unexported fields
}

func (*Datadog) Close

func (*Datadog) Close() error

func (*Datadog) Connect

func (d *Datadog) Connect() error

func (*Datadog) SampleConfig

func (*Datadog) SampleConfig() string

func (*Datadog) Write

func (d *Datadog) Write(metrics []telegraf.Metric) error

type Metric

type Metric struct {
	Metric   string   `json:"metric"`
	Points   [1]Point `json:"points"`
	Host     string   `json:"host"`
	Type     string   `json:"type,omitempty"`
	Tags     []string `json:"tags,omitempty"`
	Interval int64    `json:"interval"`
}

type Point

type Point [2]float64

type TimeSeries

type TimeSeries struct {
	Series []*Metric `json:"series"`
}