opentelemetry-go/exporter/metric/stdout/stdout_test.go

package stdout_test

import (
	"bytes"
	"context"
	"encoding/json"
	"strings"
	"testing"
	"time"

	"github.com/stretchr/testify/require"

	"go.opentelemetry.io/otel/api/core"
	"go.opentelemetry.io/otel/api/key"
	"go.opentelemetry.io/otel/exporter/metric/stdout"
	"go.opentelemetry.io/otel/exporter/metric/test"
	export "go.opentelemetry.io/otel/sdk/export/metric"
	"go.opentelemetry.io/otel/sdk/export/metric/aggregator"
	sdk "go.opentelemetry.io/otel/sdk/metric"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/array"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/counter"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/ddsketch"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/gauge"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/maxsumcount"
	aggtest "go.opentelemetry.io/otel/sdk/metric/aggregator/test"
)

type testFixture struct {
	t        *testing.T
	ctx      context.Context
	exporter *stdout.Exporter
	output   *bytes.Buffer
}

func newFixture(t *testing.T, options stdout.Options) testFixture {
	buf := &bytes.Buffer{}
	options.File = buf
	options.DoNotPrintTime = true
	exp, err := stdout.New(options)
	if err != nil {
		t.Fatal("Error building fixture: ", err)
	}
	return testFixture{
		t:        t,
		ctx:      context.Background(),
		exporter: exp,
		output:   buf,
	}
}

func (fix testFixture) Output() string {
	return strings.TrimSpace(fix.output.String())
}

func (fix testFixture) Export(checkpointSet export.CheckpointSet) {
	err := fix.exporter.Export(fix.ctx, checkpointSet)
	if err != nil {
		fix.t.Error("export failed: ", err)
	}
}

func TestStdoutInvalidQuantile(t *testing.T) {
	_, err := stdout.New(stdout.Options{
		Quantiles: []float64{1.1, 0.9},
	})
	require.Error(t, err, "Invalid quantile error expected")
	require.Equal(t, aggregator.ErrInvalidQuantile, err)
}

func TestStdoutTimestamp(t *testing.T) {
	var buf bytes.Buffer
	exporter, err := stdout.New(stdout.Options{
		File:           &buf,
		DoNotPrintTime: false,
	})
	if err != nil {
		t.Fatal("Invalid options: ", err)
	}

	before := time.Now()

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	ctx := context.Background()
	desc := export.NewDescriptor("test.name", export.GaugeKind, nil, "", "", core.Int64NumberKind, false)
	gagg := gauge.New()
	aggtest.CheckedUpdate(t, gagg, core.NewInt64Number(321), desc)
	gagg.Checkpoint(ctx, desc)

	checkpointSet.Add(desc, gagg)

	if err := exporter.Export(ctx, checkpointSet); err != nil {
		t.Fatal("Unexpected export error: ", err)
	}

	after := time.Now()

	var printed map[string]interface{}

	if err := json.Unmarshal(buf.Bytes(), &printed); err != nil {
		t.Fatal("JSON parse error: ", err)
	}

	updateTS := printed["time"].(string)
	updateTimestamp, err := time.Parse(time.RFC3339Nano, updateTS)
	if err != nil {
		t.Fatal("JSON parse error: ", updateTS, ": ", err)
	}

	gaugeTS := printed["updates"].([]interface{})[0].(map[string]interface{})["time"].(string)
	gaugeTimestamp, err := time.Parse(time.RFC3339Nano, gaugeTS)
	if err != nil {
		t.Fatal("JSON parse error: ", gaugeTS, ": ", err)
	}

	require.True(t, updateTimestamp.After(before))
	require.True(t, updateTimestamp.Before(after))

	require.True(t, gaugeTimestamp.After(before))
	require.True(t, gaugeTimestamp.Before(after))

	require.True(t, gaugeTimestamp.Before(updateTimestamp))
}

func TestStdoutCounterFormat(t *testing.T) {
	fix := newFixture(t, stdout.Options{})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.CounterKind, nil, "", "", core.Int64NumberKind, false)
	cagg := counter.New()
	aggtest.CheckedUpdate(fix.t, cagg, core.NewInt64Number(123), desc)
	cagg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, cagg, key.String("A", "B"), key.String("C", "D"))

	fix.Export(checkpointSet)

	require.Equal(t, `{"updates":[{"name":"test.name{A=B,C=D}","sum":123}]}`, fix.Output())
}

func TestStdoutGaugeFormat(t *testing.T) {
	fix := newFixture(t, stdout.Options{})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.GaugeKind, nil, "", "", core.Float64NumberKind, false)
	gagg := gauge.New()
	aggtest.CheckedUpdate(fix.t, gagg, core.NewFloat64Number(123.456), desc)
	gagg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, gagg, key.String("A", "B"), key.String("C", "D"))

	fix.Export(checkpointSet)

	require.Equal(t, `{"updates":[{"name":"test.name{A=B,C=D}","last":123.456}]}`, fix.Output())
}

func TestStdoutMaxSumCount(t *testing.T) {
	fix := newFixture(t, stdout.Options{})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.MeasureKind, nil, "", "", core.Float64NumberKind, false)
	magg := maxsumcount.New()
	aggtest.CheckedUpdate(fix.t, magg, core.NewFloat64Number(123.456), desc)
	aggtest.CheckedUpdate(fix.t, magg, core.NewFloat64Number(876.543), desc)
	magg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, magg, key.String("A", "B"), key.String("C", "D"))

	fix.Export(checkpointSet)

	require.Equal(t, `{"updates":[{"name":"test.name{A=B,C=D}","max":876.543,"sum":999.999,"count":2}]}`, fix.Output())
}

func TestStdoutMeasureFormat(t *testing.T) {
	fix := newFixture(t, stdout.Options{
		PrettyPrint: true,
	})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.MeasureKind, nil, "", "", core.Float64NumberKind, false)
	magg := array.New()

	for i := 0; i < 1000; i++ {
		aggtest.CheckedUpdate(fix.t, magg, core.NewFloat64Number(float64(i)+0.5), desc)
	}

	magg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, magg, key.String("A", "B"), key.String("C", "D"))

	fix.Export(checkpointSet)

	require.Equal(t, `{
	"updates": [
		{
			"name": "test.name{A=B,C=D}",
			"max": 999.5,
			"sum": 500000,
			"count": 1000,
			"quantiles": [
				{
					"q": 0.5,
					"v": 500.5
				},
				{
					"q": 0.9,
					"v": 900.5
				},
				{
					"q": 0.99,
					"v": 990.5
				}
			]
		}
	]
}`, fix.Output())
}

func TestStdoutAggError(t *testing.T) {
	fix := newFixture(t, stdout.Options{})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.MeasureKind, nil, "", "", core.Float64NumberKind, false)
	magg := ddsketch.New(ddsketch.NewDefaultConfig(), desc)
	magg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, magg)

	err := fix.exporter.Export(fix.ctx, checkpointSet)

	// An error is returned and NaN values are printed.
	require.Error(t, err)
	require.Equal(t, aggregator.ErrEmptyDataSet, err)
	require.Equal(t, `{"updates":[{"name":"test.name","max":"NaN","sum":0,"count":0,"quantiles":[{"q":0.5,"v":"NaN"},{"q":0.9,"v":"NaN"},{"q":0.99,"v":"NaN"}]}]}`, fix.Output())
}

func TestStdoutGaugeNotSet(t *testing.T) {
	fix := newFixture(t, stdout.Options{})

	checkpointSet := test.NewCheckpointSet(sdk.DefaultLabelEncoder())

	desc := export.NewDescriptor("test.name", export.GaugeKind, nil, "", "", core.Float64NumberKind, false)
	gagg := gauge.New()
	gagg.Checkpoint(fix.ctx, desc)

	checkpointSet.Add(desc, gagg, key.String("A", "B"), key.String("C", "D"))

	fix.Export(checkpointSet)

	require.Equal(t, `{"updates":null}`, fix.Output())
}