datadog

package
v1.31.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2024 License: MIT Imports: 16 Imported by: 186

README

Datadog Output Plugin

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

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"

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.

We do not send Rate types. Counts are sent as count, with an interval hard-coded to 1. Note that this behavior does not play super-well if running simultaneously with current Datadog agents; they will attempt to change to Rate with interval=10. We prefer this method, however, as it reflects the raw data more accurately.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Datadog

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

	proxy.HTTPProxy
	// contains filtered or unexported fields
}

func (*Datadog) Close

func (d *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"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL