go.opentelemetry.io/otel/sdk/metric v1.37.0: WithResource

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.WithResource 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.WithResource

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.

package sample

import (
	"context"
	"testing"

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

func TestContract_WithResource(t *testing.T) {
	ctx := context.Background()

	// Assertion 1: WithResource associates a configured Resource with a MeterProvider
	res := resource.NewSchemaless(
		attribute.String("service.name", "contract-test-service"),
		attribute.String("service.version", "1.0.0"),
	)

	reader := sdkmetric.NewManualReader()
	provider := sdkmetric.NewMeterProvider(
		sdkmetric.WithResource(res),
		sdkmetric.WithReader(reader),
	)

	// Assertion 2: Meters created from the MeterProvider produce metrics carrying the Resource attributes
	meter := provider.Meter("sample.meter")
	counter, err := meter.Int64Counter("sample.counter")
	if err != nil {
		t.Fatalf("failed to create counter: %v", err)
	}
	counter.Add(ctx, 42)

	// Assertion 3: Collected ResourceMetrics retain the custom attributes from WithResource
	var rm metricdata.ResourceMetrics
	if err := reader.Collect(ctx, &rm); err != nil {
		t.Fatalf("failed to collect metrics: %v", err)
	}

	if rm.Resource == nil {
		t.Fatal("expected non-nil Resource on collected ResourceMetrics")
	}

	foundName := false
	foundVersion := false
	for _, attr := range rm.Resource.Attributes() {
		if attr.Key == "service.name" && attr.Value.AsString() == "contract-test-service" {
			foundName = true
		}
		if attr.Key == "service.version" && attr.Value.AsString() == "1.0.0" {
			foundVersion = true
		}
	}

	if !foundName {
		t.Errorf("expected service.name to be 'contract-test-service' on resource")
	}
	if !foundVersion {
		t.Errorf("expected service.version to be '1.0.0' on resource")
	}

	// Assertion 4: MeterProvider shuts down cleanly when configured with WithResource
	if err := provider.Shutdown(ctx); err != nil {
		t.Fatalf("expected clean shutdown, got %v", err)
	}
}

func TestContract_MetricServiceHelper(t *testing.T) {
	ctx := context.Background()

	svc, err := NewMetricService("helper-service", "2.1.0")
	if err != nil {
		t.Fatalf("NewMetricService failed: %v", err)
	}
	defer svc.Shutdown(ctx)

	if err := svc.RecordSampleMetric(ctx, "helper.meter", "helper.counter", 10); err != nil {
		t.Fatalf("RecordSampleMetric failed: %v", err)
	}

	rm, err := svc.Collect(ctx)
	if err != nil {
		t.Fatalf("Collect failed: %v", err)
	}

	if rm.Resource == nil {
		t.Fatal("expected non-nil Resource on helper metrics")
	}

	found := false
	for _, attr := range rm.Resource.Attributes() {
		if attr.Key == "service.name" && attr.Value.AsString() == "helper-service" {
			found = true
			break
		}
	}
	if !found {
		t.Errorf("expected helper-service attribute on resource")
	}
}

{"case":{"caseId":"case:sha256:566ae657fa0702378b376e3c8607b5e89818f4d461fa92b4f88a3fdf45bce9f6","contract":["WithResource associates a configured Resource with a MeterProvider","Collected ResourceMetrics retain the custom attributes from WithResource","Meters created from the MeterProvider produce metrics carrying the Resource attributes","MeterProvider shuts down cleanly when configured with WithResource"],"goal":"verify go.opentelemetry.io/otel/sdk/metric.WithResource 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.WithResource"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","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.WithResource"],"verifierAdapter":"golang@1"}

module sample

go 1.24

require (
	go.opentelemetry.io/otel v1.37.0
	go.opentelemetry.io/otel/sdk 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/metric 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=

package sample

import (
	"context"
	"fmt"

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

// MetricService wraps a MeterProvider configured with a custom Resource and a ManualReader.
type MetricService struct {
	provider *sdkmetric.MeterProvider
	reader   *sdkmetric.ManualReader
}

// NewMetricService creates a new MetricService with the given service name and version attributes.
// It applies sdkmetric.WithResource to bind the resource to the MeterProvider.
func NewMetricService(serviceName, serviceVersion string) (*MetricService, error) {
	res := resource.NewSchemaless(
		attribute.String("service.name", serviceName),
		attribute.String("service.version", serviceVersion),
	)

	reader := sdkmetric.NewManualReader()
	provider := sdkmetric.NewMeterProvider(
		sdkmetric.WithResource(res),
		sdkmetric.WithReader(reader),
	)

	return &MetricService{
		provider: provider,
		reader:   reader,
	}, nil
}

// RecordSampleMetric creates an Int64Counter and records a value.
func (s *MetricService) RecordSampleMetric(ctx context.Context, meterName, counterName string, value int64) error {
	meter := s.provider.Meter(meterName)
	counter, err := meter.Int64Counter(counterName)
	if err != nil {
		return fmt.Errorf("create counter %s: %w", counterName, err)
	}
	counter.Add(ctx, value)
	return nil
}

// Collect gathers metric data into ResourceMetrics.
func (s *MetricService) Collect(ctx context.Context) (*metricdata.ResourceMetrics, error) {
	var rm metricdata.ResourceMetrics
	if err := s.reader.Collect(ctx, &rm); err != nil {
		return nil, fmt.Errorf("collect metrics: %w", err)
	}
	return &rm, nil
}

// Shutdown shuts down the MeterProvider.
func (s *MetricService) Shutdown(ctx context.Context) error {
	return s.provider.Shutdown(ctx)
}

{
  "schemaVersion": 1,
  "goal": "verify go.opentelemetry.io/otel/sdk/metric.WithResource 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.WithResource"
  ]
}