Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[exporter/datadog] Add telemetry metric for runtime metrics #23138

Merged
Prev Previous commit
Next Next commit
Change DefaultMetrics function signature
  • Loading branch information
liustanley committed Jun 6, 2023
commit 5a46afa9e84eae61856560cf71eda73a54247342
7 changes: 4 additions & 3 deletions exporter/datadogexporter/internal/metrics/consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,24 @@
}

// runningMetrics gets the running metrics for the exporter.
func (c *Consumer) runningMetrics(timestamp uint64, buildInfo component.BuildInfo, metadata metrics.RuntimeMetricsTelemetry) (series []datadogV2.MetricSeries) {

Check failure on line 57 in exporter/datadogexporter/internal/metrics/consumer.go

View workflow job for this annotation

GitHub Actions / govulncheck (exporter)

RuntimeMetricsTelemetry not declared by package metrics
for host := range c.seenHosts {
// Report the host as running
runningMetric := DefaultMetrics("metrics", host, timestamp, buildInfo, "")
runningMetric := DefaultMetrics("metrics", host, timestamp, TagsFromBuildInfo(buildInfo))
liustanley marked this conversation as resolved.
Show resolved Hide resolved
series = append(series, runningMetric...)
}

for tag := range c.seenTags {
runningMetrics := DefaultMetrics("metrics", "", timestamp, buildInfo, "")
runningMetrics := DefaultMetrics("metrics", "", timestamp, TagsFromBuildInfo(buildInfo))
for i := range runningMetrics {
runningMetrics[i].Tags = append(runningMetrics[i].Tags, tag)
}
series = append(series, runningMetrics...)
}

for _, lang := range metadata.LanguageTags {
runningMetric := DefaultMetrics("runtime_metrics", "", timestamp, buildInfo, lang)
tags := append(TagsFromBuildInfo(buildInfo), "language:"+lang)
runningMetric := DefaultMetrics("runtime_metrics", "", timestamp, tags)
series = append(series, runningMetric...)
}

Expand All @@ -78,7 +79,7 @@
}

// All gets all metrics (consumed metrics and running metrics).
func (c *Consumer) All(timestamp uint64, buildInfo component.BuildInfo, tags []string, metadata metrics.RuntimeMetricsTelemetry) ([]datadogV2.MetricSeries, sketches.SketchSeriesList, []pb.ClientStatsPayload) {

Check failure on line 82 in exporter/datadogexporter/internal/metrics/consumer.go

View workflow job for this annotation

GitHub Actions / govulncheck (exporter)

RuntimeMetricsTelemetry not declared by package metrics
series := c.ms
series = append(series, c.runningMetrics(timestamp, buildInfo, metadata)...)
if len(tags) == 0 {
Expand Down
16 changes: 10 additions & 6 deletions exporter/datadogexporter/internal/metrics/consumer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ func TestRunningMetrics(t *testing.T) {

ctx := context.Background()
consumer := NewConsumer()
_, err := tr.MapMetrics(ctx, ms, consumer)
metadata, err := tr.MapMetrics(ctx, ms, consumer)
assert.NoError(t, err)

var runningHostnames []string
for _, metric := range consumer.runningMetrics(0, component.BuildInfo{}) {
for _, metric := range consumer.runningMetrics(0, component.BuildInfo{}, metadata) {
for _, res := range metric.Resources {
runningHostnames = append(runningHostnames, *res.Name)
}
Expand Down Expand Up @@ -104,10 +104,10 @@ func TestTagsMetrics(t *testing.T) {

ctx := context.Background()
consumer := NewConsumer()
_, err := tr.MapMetrics(ctx, ms, consumer)
metadata, err := tr.MapMetrics(ctx, ms, consumer)
assert.NoError(t, err)

runningMetrics := consumer.runningMetrics(0, component.BuildInfo{})
runningMetrics := consumer.runningMetrics(0, component.BuildInfo{}, metadata)
var runningTags []string
var runningHostnames []string
for _, metric := range runningMetrics {
Expand All @@ -123,15 +123,19 @@ func TestTagsMetrics(t *testing.T) {
}

func TestConsumeAPMStats(t *testing.T) {
metadata := metrics.RuntimeMetricsTelemetry{
HasRuntimeMetrics: false,
LanguageTags: nil,
}
c := NewConsumer()
for _, sp := range testutil.StatsPayloads {
c.ConsumeAPMStats(sp)
}
require.Len(t, c.as, len(testutil.StatsPayloads))
require.ElementsMatch(t, c.as, testutil.StatsPayloads)
_, _, out := c.All(0, component.BuildInfo{}, []string{})
_, _, out := c.All(0, component.BuildInfo{}, []string{}, metadata)
require.ElementsMatch(t, out, testutil.StatsPayloads)
_, _, out = c.All(0, component.BuildInfo{}, []string{"extra:key"})
_, _, out = c.All(0, component.BuildInfo{}, []string{"extra:key"}, metadata)
var copies []pb.ClientStatsPayload
for _, sp := range testutil.StatsPayloads {
sp.Tags = append(sp.Tags, "extra:key")
Expand Down
24 changes: 13 additions & 11 deletions exporter/datadogexporter/internal/metrics/series.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,7 @@ func NewCount(name string, ts uint64, value float64, tags []string) datadogV2.Me
}

// DefaultMetrics creates built-in metrics to report that an exporter is running
func DefaultMetrics(exporterType string, hostname string, timestamp uint64, buildInfo component.BuildInfo, language string) []datadogV2.MetricSeries {
var tags []string
if buildInfo.Version != "" {
tags = append(tags, "version:"+buildInfo.Version)
}
if buildInfo.Command != "" {
tags = append(tags, "command:"+buildInfo.Command)
}
if language != "" {
tags = append(tags, "language:"+language)
}
func DefaultMetrics(exporterType string, hostname string, timestamp uint64, tags []string) []datadogV2.MetricSeries {
metrics := []datadogV2.MetricSeries{
NewGauge(fmt.Sprintf("otel.datadog_exporter.%s.running", exporterType), timestamp, 1.0, tags),
}
Expand All @@ -76,3 +66,15 @@ func DefaultMetrics(exporterType string, hostname string, timestamp uint64, buil
}
return metrics
}

// TagsFromBuildInfo returns a list of tags derived from buildInfo to be used when creating metrics
func TagsFromBuildInfo(buildInfo component.BuildInfo) []string {
var tags []string
if buildInfo.Version != "" {
tags = append(tags, "version:"+buildInfo.Version)
}
if buildInfo.Command != "" {
tags = append(tags, "command:"+buildInfo.Command)
}
return tags
}
24 changes: 23 additions & 1 deletion exporter/datadogexporter/internal/metrics/series_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func TestDefaultMetrics(t *testing.T) {
Command: "otelcontribcol",
}

ms := DefaultMetrics("metrics", "test-host", uint64(2e9), buildInfo)
ms := DefaultMetrics("metrics", "test-host", uint64(2e9), TagsFromBuildInfo(buildInfo))

assert.Equal(t, "otel.datadog_exporter.metrics.running", ms[0].Metric)
// Assert metrics list length (should be 1)
Expand All @@ -61,3 +61,25 @@ func TestDefaultMetrics(t *testing.T) {
// Assert no other tags are set
assert.ElementsMatch(t, []string{"version:1.0", "command:otelcontribcol"}, ms[0].Tags)
}

func TestDefaultMetricsWithRuntimeMetrics(t *testing.T) {
buildInfo := component.BuildInfo{
Version: "1.0",
Command: "otelcontribcol",
}

tags := append(TagsFromBuildInfo(buildInfo), "language:go")
ms := DefaultMetrics("runtime_metrics", "test-host", uint64(2e9), tags)

assert.Equal(t, "otel.datadog_exporter.runtime_metrics.running", ms[0].Metric)
// Assert metrics list length (should be 1)
assert.Equal(t, 1, len(ms))
// Assert timestamp
assert.Equal(t, int64(2), *ms[0].Points[0].Timestamp)
// Assert value (should always be 1.0)
assert.Equal(t, 1.0, *ms[0].Points[0].Value)
// Assert hostname tag is set
assert.Equal(t, "test-host", *ms[0].Resources[0].Name)
// Assert no other tags are set
assert.ElementsMatch(t, []string{"version:1.0", "command:otelcontribcol", "language:go"}, ms[0].Tags)
}
4 changes: 2 additions & 2 deletions exporter/datadogexporter/traces_exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ func (exp *traceExporter) exportUsageMetrics(ctx context.Context, hosts map[stri
if isMetricExportV2Enabled() {
series := make([]datadogV2.MetricSeries, 0, len(hosts)+len(tags))
for host := range hosts {
series = append(series, metrics.DefaultMetrics("traces", host, uint64(now), exp.params.BuildInfo, "")...)
series = append(series, metrics.DefaultMetrics("traces", host, uint64(now), metrics.TagsFromBuildInfo(exp.params.BuildInfo))...)
liustanley marked this conversation as resolved.
Show resolved Hide resolved
}
for tag := range tags {
ms := metrics.DefaultMetrics("traces", "", uint64(now), exp.params.BuildInfo, "")
ms := metrics.DefaultMetrics("traces", "", uint64(now), metrics.TagsFromBuildInfo(exp.params.BuildInfo))
for i := range ms {
ms[i].Tags = append(ms[i].Tags, tag)
}
Expand Down
Loading