metrics

Documentation

Index

• func AddProcessor(ctx context.Context, processor Processor) context.Context
• type APIClient
  • func MakeAPIClient(ctx context.Context, baseAPIURL, apiKey, appKey string) *APIClient
  • func (cl *APIClient) PrewarmConnection() error
  • func (cl *APIClient) SendMetrics(metrics []APIMetric) error
• type APIMetric
• type BatchKey
• type Batcher
  • func MakeBatcher(batchInterval time.Duration) *Batcher
  • func (b *Batcher) AddMetric(timestamp time.Time, metric Metric)
  • func (b *Batcher) ToAPIMetrics(timestamp time.Time) []APIMetric
• type Client
• type Config
• type Distribution
  • func (d *Distribution) AddPoint(value float64)
  • func (d *Distribution) Join(metric Metric)
  • func (d *Distribution) ToAPIMetric(timestamp time.Time, interval time.Duration) []APIMetric
  • func (d *Distribution) ToBatchKey() BatchKey
• type Listener
  • func MakeListener(config Config) Listener
  • func (l *Listener) HandlerFinished(ctx context.Context)
  • func (l *Listener) HandlerStarted(ctx context.Context, msg json.RawMessage) context.Context
• type Metric
• type MetricType
• type Processor
  • func GetProcessor(ctx context.Context) Processor
  • func MakeProcessor(ctx context.Context, client Client, timeService TimeService, ...) Processor
• type TimeService
  • func MakeTimeService() TimeService

Functions

func AddProcessor

func AddProcessor(ctx context.Context, processor Processor) context.Context

AddProcessor adds a processor to a context object

Types

type APIClient

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient send metrics to Datadog, via the Datadog API

func MakeAPIClient

func MakeAPIClient(ctx context.Context, baseAPIURL, apiKey, appKey string) *APIClient

MakeAPIClient creates a new API client with the given api and app keys

func (*APIClient) PrewarmConnection

func (cl *APIClient) PrewarmConnection() error

PrewarmConnection sends a redundant GET request to the Datadog API to prewarm the TSL connection

func (*APIClient) SendMetrics

func (cl *APIClient) SendMetrics(metrics []APIMetric) error

SendMetrics posts a batch metrics payload to the Datadog API

type APIMetric

type APIMetric struct {
	Name       string      `json:"metric"`
	Host       *string     `json:"host,omitempty"`
	Tags       []string    `json:"tags,omitempty"`
	MetricType MetricType  `json:"type"`
	Interval   *float64    `json:"interval,omitempty"`
	Points     [][]float64 `json:"points"`
}

APIMetric is a metric that can be marshalled to send to the metrics API

type BatchKey

type BatchKey struct {
	// contains filtered or unexported fields
}

BatchKey identifies a batch of metrics

type Batcher

type Batcher struct {
	// contains filtered or unexported fields
}

Batcher aggregates metrics with common properties,(metric name, tags, type etc)

func MakeBatcher

func MakeBatcher(batchInterval time.Duration) *Batcher

MakeBatcher creates a new batcher object

func (*Batcher) AddMetric

func (b *Batcher) AddMetric(timestamp time.Time, metric Metric)

AddMetric adds a point to a given metric

func (*Batcher) ToAPIMetrics

func (b *Batcher) ToAPIMetrics(timestamp time.Time) []APIMetric

ToAPIMetrics converts the current batch of metrics into API metrics

type Client

type Client interface {
	SendMetrics(metrics []APIMetric) error
}

Client sends metrics to Datadog

type Config

type Config struct {
	APIKey               string
	AppKey               string
	ShouldRetryOnFailure bool
	BatchInterval        time.Duration
}

Config gives options for how the listener should work

type Distribution

type Distribution struct {
	Name   string
	Tags   []string
	Host   *string
	Values []float64
}

Distribution is a type of metric that is aggregated over multiple hosts

func (*Distribution) AddPoint

func (d *Distribution) AddPoint(value float64)

AddPoint adds a point to the distribution metric

func (*Distribution) Join

func (d *Distribution) Join(metric Metric)

Join creates a union between two metric sets

func (*Distribution) ToAPIMetric

func (d *Distribution) ToAPIMetric(timestamp time.Time, interval time.Duration) []APIMetric

ToAPIMetric converts a distribution into an API ready format.

func (*Distribution) ToBatchKey

func (d *Distribution) ToBatchKey() BatchKey

ToBatchKey returns a key that can be used to batch the metric

type Listener

type Listener struct {
	// contains filtered or unexported fields
}

Listener implements wrapper.HandlerListener, injecting metrics into the context

func MakeListener

func MakeListener(config Config) Listener

MakeListener initializes a new metrics lambda listener

func (*Listener) HandlerFinished

func (l *Listener) HandlerFinished(ctx context.Context)

HandlerFinished implemented as part of the wrapper.HandlerListener interface

func (*Listener) HandlerStarted

func (l *Listener) HandlerStarted(ctx context.Context, msg json.RawMessage) context.Context

HandlerStarted adds metrics service to the context

type Metric

type Metric interface {
	AddPoint(value float64)
	ToAPIMetric(timestamp time.Time, interval time.Duration) []APIMetric
	ToBatchKey() BatchKey
	Join(metric Metric)
}

Metric represents a metric that can have any kind of

type MetricType

type MetricType string

MetricType enumerates all the available metric types

const (

	// DistributionType represents a distribution metric
	DistributionType MetricType = "distribution"
)

type Processor

type Processor interface {
	// AddMetric sends a metric to the agent
	AddMetric(metric Metric)
	// StartProcessing begins processing metrics asynchronously
	StartProcessing()
	// FinishProcessing shuts down the agent, and tries to flush any remaining metrics
	FinishProcessing()
}

Processor is used to batch metrics on a background thread, and send them on to a client periodically.

func GetProcessor

func GetProcessor(ctx context.Context) Processor

GetProcessor retrieves the processor from a context object.

func MakeProcessor

func MakeProcessor(ctx context.Context, client Client, timeService TimeService, batchInterval time.Duration, shouldRetryOnFail bool) Processor

MakeProcessor creates a new metrics context

type TimeService

type TimeService interface {
	NewTicker(duration time.Duration) *time.Ticker
	Now() time.Time
}

TimeService wraps common time related operations

func MakeTimeService

func MakeTimeService() TimeService

MakeTimeService creates a new time service