datadog

Documentation

Index

• func ParseStream(r io.Reader, contentEncoding string, callback func(series []Series) error) error
• func SplitTag(tag string) (string, string)
• type Point
  • func (pt *Point) Timestamp() int64
  • func (pt *Point) Value() float64
• type Request
  • func (req *Request) Unmarshal(b []byte) error
• type Series

Functions

func ParseStream

func ParseStream(r io.Reader, contentEncoding string, callback func(series []Series) error) error

ParseStream parses DataDog POST request for /api/v1/series from reader and calls callback for the parsed request.

callback shouldn't hold series after returning.

func SplitTag

func SplitTag(tag string) (string, string)

SplitTag splits DataDog tag into tag name and value.

See https://docs.datadoghq.com/getting_started/tagging/#define-tags

Types

type Point

type Point [2]float64

Point represents a point from DataDog POST request to /api/v1/series

func (*Point) Timestamp

func (pt *Point) Timestamp() int64

Timestamp returns timestamp in milliseconds from the given pt.

func (*Point) Value

func (pt *Point) Value() float64

Value returns value from the given pt.

type Request

type Request struct {
	Series []Series `json:"series"`
}

Request represents DataDog POST request to /api/v1/series

See https://docs.datadoghq.com/api/latest/metrics/#submit-metrics

func (*Request) Unmarshal

func (req *Request) Unmarshal(b []byte) error

Unmarshal unmarshals DataDog /api/v1/series request body from b to req.

See https://docs.datadoghq.com/api/latest/metrics/#submit-metrics

b shouldn't be modified when req is in use.

type Series

type Series struct {
	Metric string `json:"metric"`
	Host   string `json:"host"`

	// The device field does not appear in the datadog docs, but datadog-agent does use it.
	// Datadog agent (v7 at least), removes the tag "device" and adds it as its own field. Why? That I don't know!
	// https://github.com/DataDog/datadog-agent/blob/0ada7a97fed6727838a6f4d9c87123d2aafde735/pkg/metrics/series.go#L84-L105
	Device string `json:"device"`

	Points []Point  `json:"points"`
	Tags   []string `json:"tags"`
}

Series represents a series item from DataDog POST request to /api/v1/series

See https://docs.datadoghq.com/api/latest/metrics/#submit-metrics