go.opentelemetry.io/otel/sdk/metric v1.37.0: metricdata.Sum

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify go.opentelemetry.io/otel/sdk/metric/metricdata.Sum in pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0
Demonstrate these symbols/APIs:
  - go.opentelemetry.io/otel/sdk/metric/metricdata.Sum

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:be9e99d7e9c0c26f439c0eeda757593782d41a12da166ec8fab1de7fec13b1b8","contract":["Sum[N int64 | float64] encapsulates aggregated sum data points with temporality and monotonicity","Sum implements Aggregation interface for embedding in Metrics record","Int64Counter collections yield metricdata.Sum[int64] with CumulativeTemporality and IsMonotonic true","Sum support for float64 values with DeltaTemporality and non-monotonic measurements"],"goal":"verify go.opentelemetry.io/otel/sdk/metric/metricdata.Sum in pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0","kind":"HOW","packages":["pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0"],"schemaVersion":1,"symbols":["go.opentelemetry.io/otel/sdk/metric/metricdata.Sum"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","moduleSystem":"go.mod","os":"linux","osVersionBucket":"24","packageManager":"go","runtime":"go","runtimeVersion":"1.26","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0"],"schemaVersion":1,"subject":"pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0","symbols":["go.opentelemetry.io/otel/sdk/metric/metricdata.Sum"],"verifierAdapter":"golang@1"}

module example.com/otel-metric-sum

go 1.26.6

require (
	go.opentelemetry.io/otel v1.37.0
	go.opentelemetry.io/otel/metric v1.37.0
	go.opentelemetry.io/otel/sdk/metric v1.37.0
)

require (
	github.com/go-logr/logr v1.4.3 // indirect
	github.com/go-logr/stdr v1.2.2 // indirect
	github.com/google/uuid v1.6.0 // indirect
	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
	go.opentelemetry.io/otel/sdk v1.37.0 // indirect
	go.opentelemetry.io/otel/trace v1.37.0 // indirect
	golang.org/x/sys v0.33.0 // indirect
)

github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
go.opentelemetry.io/otel v1.37.0 h1:9zhNfelUvx0KBfu/gb+ZgeAfAgtWrfHJZcAqFC228wQ=
go.opentelemetry.io/otel v1.37.0/go.mod h1:ehE/umFRLnuLa/vSccNq9oS1ErUlkkK71gMcN34UG8I=
go.opentelemetry.io/otel/metric v1.37.0 h1:mvwbQS5m0tbmqML4NqK+e3aDiO02vsf/WgbsdpcPoZE=
go.opentelemetry.io/otel/metric v1.37.0/go.mod h1:04wGrZurHYKOc+RKeye86GwKiTb9FKm1WHtO+4EVr2E=
go.opentelemetry.io/otel/sdk v1.37.0 h1:ItB0QUqnjesGRvNcmAcU0LyvkVyGJ2xftD29bWdDvKI=
go.opentelemetry.io/otel/sdk v1.37.0/go.mod h1:VredYzxUvuo2q3WRcDnKDjbdvmO0sCzOvVAiY+yUkAg=
go.opentelemetry.io/otel/sdk/metric v1.37.0 h1:90lI228XrB9jCMuSdA0673aubgRobVZFhbjxHHspCPc=
go.opentelemetry.io/otel/sdk/metric v1.37.0/go.mod h1:cNen4ZWfiD37l5NhS+Keb5RXVWZWpRE+9WyVCpbo5ps=
go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mxVK7z4=
go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0=
golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

{
  "schemaVersion": 1,
  "goal": "verify go.opentelemetry.io/otel/sdk/metric/metricdata.Sum in pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/go.opentelemetry.io/otel/sdk/metric@v1.37.0"
  ],
  "symbols": [
    "go.opentelemetry.io/otel/sdk/metric/metricdata.Sum"
  ]
}

package sample

import (
	"context"
	"fmt"

	"go.opentelemetry.io/otel/attribute"
	otelmetric "go.opentelemetry.io/otel/metric"
	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
	"go.opentelemetry.io/otel/sdk/metric/metricdata"
)

// NewInt64CumulativeSum constructs a metricdata.Sum[int64] representing cumulative monotonic sum data points.
func NewInt64CumulativeSum(points []metricdata.DataPoint[int64], isMonotonic bool) metricdata.Sum[int64] {
	return metricdata.Sum[int64]{
		DataPoints:  points,
		Temporality: metricdata.CumulativeTemporality,
		IsMonotonic: isMonotonic,
	}
}

// NewFloat64DeltaSum constructs a metricdata.Sum[float64] representing delta sum data points.
func NewFloat64DeltaSum(points []metricdata.DataPoint[float64], isMonotonic bool) metricdata.Sum[float64] {
	return metricdata.Sum[float64]{
		DataPoints:  points,
		Temporality: metricdata.DeltaTemporality,
		IsMonotonic: isMonotonic,
	}
}

// WrapInMetrics wraps an Aggregation (such as Sum[int64] or Sum[float64]) in a metricdata.Metrics descriptor.
func WrapInMetrics(name, desc, unit string, agg metricdata.Aggregation) metricdata.Metrics {
	return metricdata.Metrics{
		Name:        name,
		Description: desc,
		Unit:        unit,
		Data:        agg,
	}
}

// CollectCounterSum produces metricdata.ResourceMetrics by exercising an Int64Counter via a ManualReader.
func CollectCounterSum(ctx context.Context, counterName string, val int64, attrs ...attribute.KeyValue) (*metricdata.ResourceMetrics, error) {
	reader := sdkmetric.NewManualReader()
	mp := sdkmetric.NewMeterProvider(sdkmetric.WithReader(reader))
	defer func() {
		_ = mp.Shutdown(ctx)
	}()

	meter := mp.Meter("example.com/otel-metric-sum")
	counter, err := meter.Int64Counter(counterName)
	if err != nil {
		return nil, fmt.Errorf("failed to create counter: %w", err)
	}

	counter.Add(ctx, val, otelmetric.WithAttributes(attrs...))

	var rm metricdata.ResourceMetrics
	if err := reader.Collect(ctx, &rm); err != nil {
		return nil, fmt.Errorf("failed to collect metrics: %w", err)
	}

	return &rm, nil
}

package test

import (
	"context"
	"testing"
	"time"

	sample "example.com/otel-metric-sum"
	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/sdk/metric/metricdata"
)

func TestMetricdataSumContract(t *testing.T) {
	ctx := context.Background()
	now := time.Now()

	// 1. Sum[N int64 | float64] encapsulates aggregated sum data points with temporality and monotonicity
	int64Points := []metricdata.DataPoint[int64]{
		{
			Attributes: attribute.NewSet(attribute.String("status", "ok")),
			StartTime:  now.Add(-time.Minute),
			Time:       now,
			Value:      42,
		},
	}
	sumInt64 := sample.NewInt64CumulativeSum(int64Points, true)
	if !sumInt64.IsMonotonic {
		t.Fatal("expected sumInt64.IsMonotonic to be true")
	}
	if sumInt64.Temporality != metricdata.CumulativeTemporality {
		t.Fatalf("expected CumulativeTemporality, got %v", sumInt64.Temporality)
	}
	if len(sumInt64.DataPoints) != 1 || sumInt64.DataPoints[0].Value != 42 {
		t.Fatalf("unexpected data points: %v", sumInt64.DataPoints)
	}

	// 2. Sum implements Aggregation interface for embedding in Metrics record
	metricRecord := sample.WrapInMetrics("requests_total", "Total requests", "1", sumInt64)
	if metricRecord.Name != "requests_total" {
		t.Fatalf("expected metric name requests_total, got %s", metricRecord.Name)
	}
	aggSum, ok := metricRecord.Data.(metricdata.Sum[int64])
	if !ok {
		t.Fatalf("expected metricRecord.Data to be metricdata.Sum[int64], got %T", metricRecord.Data)
	}
	if aggSum.DataPoints[0].Value != 42 {
		t.Fatalf("expected data point value 42, got %d", aggSum.DataPoints[0].Value)
	}

	// 3. Int64Counter collections yield metricdata.Sum[int64] with CumulativeTemporality and IsMonotonic true
	rm, err := sample.CollectCounterSum(ctx, "items_processed_total", 10, attribute.String("env", "prod"))
	if err != nil {
		t.Fatalf("CollectCounterSum failed: %v", err)
	}
	if len(rm.ScopeMetrics) == 0 || len(rm.ScopeMetrics[0].Metrics) == 0 {
		t.Fatal("expected at least one collected metric in ScopeMetrics")
	}
	collectedMetric := rm.ScopeMetrics[0].Metrics[0]
	if collectedMetric.Name != "items_processed_total" {
		t.Fatalf("expected metric name items_processed_total, got %s", collectedMetric.Name)
	}
	sdkSum, ok := collectedMetric.Data.(metricdata.Sum[int64])
	if !ok {
		t.Fatalf("expected collected Data to be metricdata.Sum[int64], got %T", collectedMetric.Data)
	}
	if !sdkSum.IsMonotonic {
		t.Fatal("expected sdkSum to be monotonic for counter")
	}
	if sdkSum.Temporality != metricdata.CumulativeTemporality {
		t.Fatalf("expected CumulativeTemporality for sdkSum, got %v", sdkSum.Temporality)
	}
	if len(sdkSum.DataPoints) != 1 || sdkSum.DataPoints[0].Value != 10 {
		t.Fatalf("expected single data point with value 10, got %v", sdkSum.DataPoints)
	}

	// 4. Sum support for float64 values with DeltaTemporality and non-monotonic measurements
	floatPoints := []metricdata.DataPoint[float64]{
		{
			Attributes: attribute.NewSet(attribute.String("direction", "in")),
			StartTime:  now.Add(-time.Second),
			Time:       now,
			Value:      3.14159,
		},
	}
	sumFloat64 := sample.NewFloat64DeltaSum(floatPoints, false)
	if sumFloat64.IsMonotonic {
		t.Fatal("expected sumFloat64.IsMonotonic to be false")
	}
	if sumFloat64.Temporality != metricdata.DeltaTemporality {
		t.Fatalf("expected DeltaTemporality, got %v", sumFloat64.Temporality)
	}
	if len(sumFloat64.DataPoints) != 1 || sumFloat64.DataPoints[0].Value != 3.14159 {
		t.Fatalf("unexpected float64 data point value: %v", sumFloat64.DataPoints)
	}
	floatRecord := sample.WrapInMetrics("bandwidth_delta", "Delta bandwidth usage", "bytes", sumFloat64)
	aggFloatSum, ok := floatRecord.Data.(metricdata.Sum[float64])
	if !ok {
		t.Fatalf("expected metricRecord.Data to be metricdata.Sum[float64], got %T", floatRecord.Data)
	}
	if aggFloatSum.DataPoints[0].Value != 3.14159 {
		t.Fatalf("expected float64 data point 3.14159, got %f", aggFloatSum.DataPoints[0].Value)
	}
}