metrics

Documentation

Overview

Package metrics contains helper functions for Datadog metric export

Index

• func DefaultMetrics(exporterType string, hostname string, timestamp uint64, ...) []datadogV2.MetricSeries
• func DefaultZorkianMetrics(exporterType string, hostname string, timestamp uint64, ...) []zorkian.Metric
• func NewCount(name string, ts uint64, value float64, tags []string) datadogV2.MetricSeries
• func NewGauge(name string, ts uint64, value float64, tags []string) datadogV2.MetricSeries
• func NewMetric(name string, dt datadogV2.MetricIntakeType, ts uint64, value float64, ...) datadogV2.MetricSeries
• func NewZorkianCount(name string, ts uint64, value float64, tags []string) zorkian.Metric
• func NewZorkianGauge(name string, ts uint64, value float64, tags []string) zorkian.Metric
• func NewZorkianMetric(name string, dt MetricType, ts uint64, value float64, tags []string) zorkian.Metric
• func PrepareContainerMetrics(ms []datadogV2.MetricSeries) []datadogV2.MetricSeries
• func PrepareSystemMetrics(ms []datadogV2.MetricSeries) []datadogV2.MetricSeries
• func PrepareZorkianContainerMetrics(ms []zorkian.Metric) []zorkian.Metric
• func PrepareZorkianSystemMetrics(ms []zorkian.Metric) []zorkian.Metric
• type Consumer
  • func NewConsumer() *Consumer
  • func (c *Consumer) All(timestamp uint64, buildInfo component.BuildInfo, tags []string) ([]datadogV2.MetricSeries, sketches.SketchSeriesList, []pb.ClientStatsPayload)
  • func (c *Consumer) ConsumeAPMStats(s pb.ClientStatsPayload)
  • func (c *Consumer) ConsumeHost(host string)
  • func (c *Consumer) ConsumeSketch(_ context.Context, dims *metrics.Dimensions, timestamp uint64, ...)
  • func (c *Consumer) ConsumeTag(tag string)
  • func (c *Consumer) ConsumeTimeSeries(_ context.Context, dims *metrics.Dimensions, typ metrics.DataType, ...)
• type MetricType
• type ZorkianConsumer
  • func NewZorkianConsumer() *ZorkianConsumer
  • func (c *ZorkianConsumer) All(timestamp uint64, buildInfo component.BuildInfo, tags []string) ([]zorkian.Metric, sketches.SketchSeriesList, []pb.ClientStatsPayload)
  • func (c *ZorkianConsumer) ConsumeAPMStats(s pb.ClientStatsPayload)
  • func (c *ZorkianConsumer) ConsumeHost(host string)
  • func (c *ZorkianConsumer) ConsumeSketch(_ context.Context, dims *metrics.Dimensions, timestamp uint64, ...)
  • func (c *ZorkianConsumer) ConsumeTag(tag string)
  • func (c *ZorkianConsumer) ConsumeTimeSeries(_ context.Context, dims *metrics.Dimensions, typ metrics.DataType, ...)

Functions

func DefaultMetrics

func DefaultMetrics(exporterType string, hostname string, timestamp uint64, buildInfo component.BuildInfo) []datadogV2.MetricSeries

DefaultMetrics creates built-in metrics to report that an exporter is running

func DefaultZorkianMetrics

func DefaultZorkianMetrics(exporterType string, hostname string, timestamp uint64, buildInfo component.BuildInfo) []zorkian.Metric

DefaultZorkianMetrics creates built-in metrics to report that an exporter is running

func NewCount

func NewCount(name string, ts uint64, value float64, tags []string) datadogV2.MetricSeries

NewCount creates a new DatadogV2 count metric given a name, a Unix nanoseconds timestamp a value and a slice of tags

func NewGauge

func NewGauge(name string, ts uint64, value float64, tags []string) datadogV2.MetricSeries

NewGauge creates a new DatadogV2 Gauge metric given a name, a Unix nanoseconds timestamp a value and a slice of tags

func NewMetric

func NewMetric(name string, dt datadogV2.MetricIntakeType, ts uint64, value float64, tags []string) datadogV2.MetricSeries

NewMetric creates a new DatadogV2 metric given a name, a type, a Unix nanoseconds timestamp a value and a slice of tags

func NewZorkianCount

func NewZorkianCount(name string, ts uint64, value float64, tags []string) zorkian.Metric

NewZorkianCount creates a new Datadog count metric given a name, a Unix nanoseconds timestamp a value and a slice of tags

func NewZorkianGauge

func NewZorkianGauge(name string, ts uint64, value float64, tags []string) zorkian.Metric

NewZorkianGauge creates a new Datadog Gauge metric given a name, a Unix nanoseconds timestamp a value and a slice of tags

func NewZorkianMetric

func NewZorkianMetric(name string, dt MetricType, ts uint64, value float64, tags []string) zorkian.Metric

NewZorkianMetric creates a new Zorkian Datadog metric given a name, a type, a Unix nanoseconds timestamp a value and a slice of tags

func PrepareContainerMetrics

func PrepareContainerMetrics(ms []datadogV2.MetricSeries) []datadogV2.MetricSeries

PrepareContainerMetrics converts OTEL container.* metrics to Datadog container metrics.

func PrepareSystemMetrics

func PrepareSystemMetrics(ms []datadogV2.MetricSeries) []datadogV2.MetricSeries

PrepareSystemMetrics prepends system hosts metrics with the otel.* prefix to identify them as part of the Datadog OpenTelemetry Integration. It also extracts Datadog compatible system metrics and returns the full set of metrics to be used.

func PrepareZorkianContainerMetrics

func PrepareZorkianContainerMetrics(ms []zorkian.Metric) []zorkian.Metric

PrepareZorkianContainerMetrics converts OTEL container.* metrics to Datadog container metrics.

func PrepareZorkianSystemMetrics

func PrepareZorkianSystemMetrics(ms []zorkian.Metric) []zorkian.Metric

PrepareZorkianSystemMetrics prepends system hosts metrics with the otel.* prefix to identify them as part of the Datadog OpenTelemetry Integration. It also extracts Datadog compatible system metrics and returns the full set of metrics to be used.

Types

type Consumer

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

Consumer implements metrics.Consumer. It records consumed metrics, sketches and APM stats payloads. It provides them to the caller using the All method.

func NewConsumer

func NewConsumer() *Consumer

NewConsumer creates a new Datadog consumer. It implements metrics.Consumer.

func (*Consumer) All

func (c *Consumer) All(timestamp uint64, buildInfo component.BuildInfo, tags []string) ([]datadogV2.MetricSeries, sketches.SketchSeriesList, []pb.ClientStatsPayload)

All gets all metrics (consumed metrics and running metrics).

func (*Consumer) ConsumeAPMStats

func (c *Consumer) ConsumeAPMStats(s pb.ClientStatsPayload)

ConsumeAPMStats implements metrics.APMStatsConsumer.

func (*Consumer) ConsumeHost

func (c *Consumer) ConsumeHost(host string)

ConsumeHost implements the metrics.HostConsumer interface.

func (*Consumer) ConsumeSketch

func (c *Consumer) ConsumeSketch(
	_ context.Context,
	dims *metrics.Dimensions,
	timestamp uint64,
	sketch *quantile.Sketch,
)

ConsumeSketch implements the metrics.Consumer interface.

func (*Consumer) ConsumeTag

func (c *Consumer) ConsumeTag(tag string)

ConsumeTag implements the metrics.TagsConsumer interface.

func (*Consumer) ConsumeTimeSeries

func (c *Consumer) ConsumeTimeSeries(
	_ context.Context,
	dims *metrics.Dimensions,
	typ metrics.DataType,
	timestamp uint64,
	value float64,
)

ConsumeTimeSeries implements the metrics.Consumer interface.

type MetricType

type MetricType string

const (
	// Gauge is the Datadog Gauge metric type
	Gauge MetricType = "gauge"
	// Count is the Datadog Count metric type
	Count MetricType = "count"
)

type ZorkianConsumer

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

ZorkianConsumer implements metrics.Consumer. It records consumed metrics, sketches and APM stats payloads. It provides them to the caller using the All method.

func NewZorkianConsumer

func NewZorkianConsumer() *ZorkianConsumer

NewZorkianConsumer creates a new ZorkianConsumer. It implements metrics.Consumer.

func (*ZorkianConsumer) All

func (c *ZorkianConsumer) All(timestamp uint64, buildInfo component.BuildInfo, tags []string) ([]zorkian.Metric, sketches.SketchSeriesList, []pb.ClientStatsPayload)

All gets all metrics (consumed metrics and running metrics).

func (*ZorkianConsumer) ConsumeAPMStats

func (c *ZorkianConsumer) ConsumeAPMStats(s pb.ClientStatsPayload)

ConsumeAPMStats implements metrics.APMStatsConsumer.

func (*ZorkianConsumer) ConsumeHost

func (c *ZorkianConsumer) ConsumeHost(host string)

ConsumeHost implements the metrics.HostConsumer interface.

func (*ZorkianConsumer) ConsumeSketch

func (c *ZorkianConsumer) ConsumeSketch(
	_ context.Context,
	dims *metrics.Dimensions,
	timestamp uint64,
	sketch *quantile.Sketch,
)

ConsumeSketch implements the metrics.Consumer interface.

func (*ZorkianConsumer) ConsumeTag

func (c *ZorkianConsumer) ConsumeTag(tag string)

ConsumeTag implements the metrics.TagsConsumer interface.

func (*ZorkianConsumer) ConsumeTimeSeries

func (c *ZorkianConsumer) ConsumeTimeSeries(
	_ context.Context,
	dims *metrics.Dimensions,
	typ metrics.DataType,
	timestamp uint64,
	value float64,
)

ConsumeTimeSeries implements the metrics.Consumer interface.