go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.43.0: New

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/exporters/otlp/otlptrace.New in pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0
Demonstrate these symbols/APIs:
  - go.opentelemetry.io/otel/exporters/otlp/otlptrace.New

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:d818fcab3c652124a1f8d057c573fcc2b80a097e4831522ccfa17baa6ec86321","contract":["otlptrace.New constructs a new trace exporter and starts the provided client","otlptrace.New exporter converts SDK spans to OTLP protobuf format and delivers them via client.UploadTraces","otlptrace.New exporter returns an error when client.Start fails during initialization","otlptrace.New exporter shutdown closes connections via client.Stop"],"goal":"verify go.opentelemetry.io/otel/exporters/otlp/otlptrace.New in pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0","kind":"HOW","packages":["pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0"],"schemaVersion":1,"symbols":["go.opentelemetry.io/otel/exporters/otlp/otlptrace.New"]},"contractCommand":["go","test","-v","./..."],"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/exporters/otlp/otlptrace@v1.43.0"],"schemaVersion":1,"subject":"pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0","symbols":["go.opentelemetry.io/otel/exporters/otlp/otlptrace.New"],"verifierAdapter":"golang@1"}

package sample

import (
	"context"
	"fmt"

	"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

// InitTraceExporter creates an OTLP trace exporter using otlptrace.New with the given client.
func InitTraceExporter(ctx context.Context, client otlptrace.Client) (*otlptrace.Exporter, error) {
	exporter, err := otlptrace.New(ctx, client)
	if err != nil {
		return nil, fmt.Errorf("failed to create otlptrace exporter: %w", err)
	}
	return exporter, nil
}

// NewTracerProviderWithExporter wraps an otlptrace.Exporter into a TracerProvider.
func NewTracerProviderWithExporter(exporter *otlptrace.Exporter) *sdktrace.TracerProvider {
	return sdktrace.NewTracerProvider(
		sdktrace.WithSyncer(exporter),
	)
}

// NewTracerProvider creates an OpenTelemetry TracerProvider configured with the otlptrace exporter.
func NewTracerProvider(ctx context.Context, client otlptrace.Client) (*sdktrace.TracerProvider, *otlptrace.Exporter, error) {
	exporter, err := InitTraceExporter(ctx, client)
	if err != nil {
		return nil, nil, err
	}

	tp := NewTracerProviderWithExporter(exporter)
	return tp, exporter, nil
}

package sample_test

import (
	"context"
	"errors"
	"sync"
	"sync/atomic"
	"testing"
	"time"

	"sample"

	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
	"go.opentelemetry.io/otel/trace"
	tracepb "go.opentelemetry.io/proto/otlp/trace/v1"
)

type mockClient struct {
	mu          sync.Mutex
	started     bool
	stopped     bool
	startErr    error
	stopErr     error
	uploadErr   error
	startCount  int64
	stopCount   int64
	uploadCount int64
	storedSpans []*tracepb.ResourceSpans
}

func (m *mockClient) Start(ctx context.Context) error {
	m.mu.Lock()
	defer m.mu.Unlock()
	atomic.AddInt64(&m.startCount, 1)
	if m.startErr != nil {
		return m.startErr
	}
	m.started = true
	return nil
}

func (m *mockClient) Stop(ctx context.Context) error {
	m.mu.Lock()
	defer m.mu.Unlock()
	atomic.AddInt64(&m.stopCount, 1)
	if m.stopErr != nil {
		return m.stopErr
	}
	m.stopped = true
	return nil
}

func (m *mockClient) UploadTraces(ctx context.Context, protoSpans []*tracepb.ResourceSpans) error {
	m.mu.Lock()
	defer m.mu.Unlock()
	atomic.AddInt64(&m.uploadCount, 1)
	if m.uploadErr != nil {
		return m.uploadErr
	}
	m.storedSpans = append(m.storedSpans, protoSpans...)
	return nil
}

func TestOtlpTraceNewSuccessAndExport(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	client := &mockClient{}

	// 1. Verify otlptrace.New initializes and starts the client
	tp, exporter, err := sample.NewTracerProvider(ctx, client)
	if err != nil {
		t.Fatalf("expected no error from NewTracerProvider, got: %v", err)
	}
	if exporter == nil {
		t.Fatalf("expected non-nil exporter")
	}
	if atomic.LoadInt64(&client.startCount) != 1 || !client.started {
		t.Fatalf("expected client.Start to be called during otlptrace.New")
	}

	// 2. Verify span generation and export delivery via client.UploadTraces
	tracer := tp.Tracer("test-tracer")
	_, span := tracer.Start(ctx, "test-operation", trace.WithAttributes(
		attribute.String("service.name", "contract-test"),
		attribute.Int("operation.id", 42),
	))
	span.End()

	if err := tp.ForceFlush(ctx); err != nil {
		t.Fatalf("failed to flush tracer provider: %v", err)
	}

	if atomic.LoadInt64(&client.uploadCount) == 0 {
		t.Fatalf("expected client.UploadTraces to be called")
	}

	client.mu.Lock()
	if len(client.storedSpans) == 0 {
		client.mu.Unlock()
		t.Fatalf("expected at least one ResourceSpans recorded")
	}

	// Verify the exported span content in protobuf format
	found := false
	for _, rs := range client.storedSpans {
		for _, ss := range rs.ScopeSpans {
			for _, s := range ss.Spans {
				if s.Name == "test-operation" {
					found = true
				}
			}
		}
	}
	client.mu.Unlock()

	if !found {
		t.Fatalf("expected span name 'test-operation' in exported protobuf spans")
	}

	// 3. Verify clean shutdown stops the client
	if err := tp.Shutdown(ctx); err != nil {
		t.Fatalf("failed to shutdown tracer provider: %v", err)
	}

	if atomic.LoadInt64(&client.stopCount) != 1 || !client.stopped {
		t.Fatalf("expected client.Stop to be called during shutdown")
	}
}

func TestOtlpTraceNewStartError(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	expectedErr := errors.New("connection failed during start")
	client := &mockClient{
		startErr: expectedErr,
	}

	exporter, err := sample.InitTraceExporter(ctx, client)
	if err == nil {
		t.Fatalf("expected error from InitTraceExporter when client.Start fails")
	}
	if exporter != nil {
		t.Fatalf("expected nil exporter when client.Start fails")
	}
	if !errors.Is(err, expectedErr) {
		t.Fatalf("expected error to wrap %v, got %v", expectedErr, err)
	}
}

func TestOtlpTraceExporterShutdownStopError(t *testing.T) {
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	expectedErr := errors.New("error closing client connection")
	client := &mockClient{
		stopErr: expectedErr,
	}

	exporter, err := otlptrace.New(ctx, client)
	if err != nil {
		t.Fatalf("expected no error from otlptrace.New, got: %v", err)
	}

	err = exporter.Shutdown(ctx)
	if err == nil {
		t.Fatalf("expected error from exporter.Shutdown when client.Stop fails")
	}
	if !errors.Is(err, expectedErr) {
		t.Fatalf("expected error to wrap %v, got %v", expectedErr, err)
	}
}

module sample

go 1.25.0

require (
	go.opentelemetry.io/otel v1.43.0
	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.43.0
	go.opentelemetry.io/otel/sdk v1.43.0
	go.opentelemetry.io/otel/trace v1.43.0
	go.opentelemetry.io/proto/otlp v1.10.0
)

require (
	github.com/cespare/xxhash/v2 v2.3.0 // indirect
	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.2.1 // indirect
	go.opentelemetry.io/otel/metric v1.43.0 // indirect
	golang.org/x/sys v0.42.0 // indirect
	google.golang.org/protobuf v1.36.11 // indirect
)

github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
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.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/otel v1.43.0 h1:mYIM03dnh5zfN7HautFE4ieIig9amkNANT+xcVxAj9I=
go.opentelemetry.io/otel v1.43.0/go.mod h1:JuG+u74mvjvcm8vj8pI5XiHy1zDeoCS2LB1spIq7Ay0=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.43.0 h1:88Y4s2C8oTui1LGM6bTWkw0ICGcOLCAI5l6zsD1j20k=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.43.0/go.mod h1:Vl1/iaggsuRlrHf/hfPJPvVag77kKyvrLeD10kpMl+A=
go.opentelemetry.io/otel/metric v1.43.0 h1:d7638QeInOnuwOONPp4JAOGfbCEpYb+K6DVWvdxGzgM=
go.opentelemetry.io/otel/metric v1.43.0/go.mod h1:RDnPtIxvqlgO8GRW18W6Z/4P462ldprJtfxHxyKd2PY=
go.opentelemetry.io/otel/sdk v1.43.0 h1:pi5mE86i5rTeLXqoF/hhiBtUNcrAGHLKQdhg4h4V9Dg=
go.opentelemetry.io/otel/sdk v1.43.0/go.mod h1:P+IkVU3iWukmiit/Yf9AWvpyRDlUeBaRg6Y+C58QHzg=
go.opentelemetry.io/otel/sdk/metric v1.43.0 h1:S88dyqXjJkuBNLeMcVPRFXpRw2fuwdvfCGLEo89fDkw=
go.opentelemetry.io/otel/sdk/metric v1.43.0/go.mod h1:C/RJtwSEJ5hzTiUz5pXF1kILHStzb9zFlIEe85bhj6A=
go.opentelemetry.io/otel/trace v1.43.0 h1:BkNrHpup+4k4w+ZZ86CZoHHEkohws8AY+WTX09nk+3A=
go.opentelemetry.io/otel/trace v1.43.0/go.mod h1:/QJhyVBUUswCphDVxq+8mld+AvhXZLhe+8WVFxiFff0=
go.opentelemetry.io/proto/otlp v1.10.0 h1:IQRWgT5srOCYfiWnpqUYz9CVmbO8bFmKcwYxpuCSL2g=
go.opentelemetry.io/proto/otlp v1.10.0/go.mod h1:/CV4QoCR/S9yaPj8utp3lvQPoqMtxXdzn7ozvvozVqk=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
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/exporters/otlp/otlptrace.New in pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/go.opentelemetry.io/otel/exporters/otlp/otlptrace@v1.43.0"
  ],
  "symbols": [
    "go.opentelemetry.io/otel/exporters/otlp/otlptrace.New"
  ]
}