go.opentelemetry.io/otel/sdk v1.43.0: WithBatcher, NewBatchSpanProcessor, ParentBased

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 pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:c9becbd01caf69ccc63f16a1b68f46bd4bdb72f350e52ebcfa7df5e2c4187544","contract":["sdktrace.WithBatcher registers a batch span processor to asynchronously batch and export spans","sdktrace.NewBatchSpanProcessor creates a BatchSpanProcessor configured with batch options","sdktrace.ParentBased creates a sampler that respects parent span sampling decisions","sdktrace.TraceIDRatioBased samples a deterministic ratio of traces based on trace ID","sdktrace.WithSpanLimits applies attribute, event, and link limits to created spans","sdktrace.NewSpanLimits returns default span limits for attribute and event counts"],"goal":"verify pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0","kind":"HOW","packages":["pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0"],"schemaVersion":1,"symbols":["WithBatcher","NewBatchSpanProcessor","ParentBased","TraceIDRatioBased","WithSpanLimits","NewSpanLimits"]},"contractCommand":["go","run","./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@v1.43.0"],"schemaVersion":1,"symbols":["WithBatcher","NewBatchSpanProcessor","ParentBased","TraceIDRatioBased","WithSpanLimits","NewSpanLimits"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require (
	go.opentelemetry.io/otel v1.43.0
	go.opentelemetry.io/otel/sdk v1.43.0
	go.opentelemetry.io/otel/trace v1.43.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
)

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/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.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=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"context"
	"fmt"
	"time"

	"go.opentelemetry.io/otel/attribute"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
	"go.opentelemetry.io/otel/sdk/trace/tracetest"
	"go.opentelemetry.io/otel/trace"
)

// BatchTelemetryService demonstrates batch span processing with parent-based sampling and span limits.
type BatchTelemetryService struct {
	exporter *tracetest.InMemoryExporter
	provider *sdktrace.TracerProvider
}

// NewBatchTelemetryService creates a telemetry pipeline configured with batch processing and custom limits.
func NewBatchTelemetryService() (*BatchTelemetryService, error) {
	exporter := tracetest.NewInMemoryExporter()

	limits := sdktrace.NewSpanLimits()
	limits.AttributeCountLimit = 5
	limits.EventCountLimit = 5

	bsp := sdktrace.NewBatchSpanProcessor(
		exporter,
		sdktrace.WithBatchTimeout(100*time.Millisecond),
		sdktrace.WithMaxExportBatchSize(32),
		sdktrace.WithMaxQueueSize(256),
	)

	sampler := sdktrace.ParentBased(
		sdktrace.TraceIDRatioBased(1.0),
	)

	tp := sdktrace.NewTracerProvider(
		sdktrace.WithSpanProcessor(bsp),
		sdktrace.WithSampler(sampler),
		sdktrace.WithSpanLimits(limits),
	)

	return &BatchTelemetryService{
		exporter: exporter,
		provider: tp,
	}, nil
}

// ExecuteBatch records spans using the batching tracer provider.
func (s *BatchTelemetryService) ExecuteBatch(ctx context.Context, operationName string) error {
	tracer := s.provider.Tracer("example.com/batch-service")
	_, span := tracer.Start(ctx, operationName, trace.WithSpanKind(trace.SpanKindInternal))
	defer span.End()

	span.SetAttributes(
		attribute.String("service.stage", "processing"),
		attribute.Int("batch.size", 10),
	)
	span.AddEvent("batch_item_processed")

	return nil
}

// Flush exports pending buffered spans immediately.
func (s *BatchTelemetryService) Flush(ctx context.Context) error {
	return s.provider.ForceFlush(ctx)
}

// Shutdown flushes and closes the telemetry provider.
func (s *BatchTelemetryService) Shutdown(ctx context.Context) error {
	return s.provider.Shutdown(ctx)
}

func main() {
	ctx := context.Background()
	service, err := NewBatchTelemetryService()
	if err != nil {
		fmt.Printf("Initialization error: %v\n", err)
		return
	}
	defer func() {
		if err := service.Shutdown(ctx); err != nil {
			fmt.Printf("Shutdown error: %v\n", err)
		}
	}()

	if err := service.ExecuteBatch(ctx, "batch-job-1"); err != nil {
		fmt.Printf("Execution error: %v\n", err)
		return
	}

	if err := service.Flush(ctx); err != nil {
		fmt.Printf("Flush error: %v\n", err)
		return
	}

	fmt.Printf("Batch processing completed successfully. Exported spans: %d\n", len(service.exporter.GetSpans()))
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

package main

import (
	"context"
	"fmt"
	"os"
	"time"

	"go.opentelemetry.io/otel/attribute"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
	"go.opentelemetry.io/otel/sdk/trace/tracetest"
	"go.opentelemetry.io/otel/trace"
)

func main() {
	ctx := context.Background()

	// Contract 1: sdktrace.NewSpanLimits returns default span limits for attribute and event counts
	limits := sdktrace.NewSpanLimits()
	if limits.AttributeCountLimit <= 0 {
		fmt.Fprintf(os.Stderr, "FAIL: expected positive default AttributeCountLimit, got %d\n", limits.AttributeCountLimit)
		os.Exit(1)
	}
	if limits.EventCountLimit <= 0 {
		fmt.Fprintf(os.Stderr, "FAIL: expected positive default EventCountLimit, got %d\n", limits.EventCountLimit)
		os.Exit(1)
	}

	// Contract 2: sdktrace.WithSpanLimits applies attribute, event, and link limits to created spans
	customLimits := sdktrace.NewSpanLimits()
	customLimits.AttributeCountLimit = 2
	customLimits.EventCountLimit = 1

	// Contract 3: sdktrace.NewBatchSpanProcessor creates a BatchSpanProcessor configured with batch options
	exporter := tracetest.NewInMemoryExporter()
	bsp := sdktrace.NewBatchSpanProcessor(
		exporter,
		sdktrace.WithBatchTimeout(50*time.Millisecond),
		sdktrace.WithMaxExportBatchSize(10),
		sdktrace.WithMaxQueueSize(100),
	)
	if bsp == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected non-nil BatchSpanProcessor from NewBatchSpanProcessor()")
		os.Exit(1)
	}

	// Contract 4: sdktrace.TraceIDRatioBased samples a deterministic ratio of traces based on trace ID
	ratioSampler := sdktrace.TraceIDRatioBased(0.5)
	if ratioSampler == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected non-nil Sampler from TraceIDRatioBased()")
		os.Exit(1)
	}

	// Contract 5: sdktrace.ParentBased creates a sampler that respects parent span sampling decisions
	parentSampler := sdktrace.ParentBased(
		sdktrace.AlwaysSample(),
	)
	if parentSampler == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected non-nil Sampler from ParentBased()")
		os.Exit(1)
	}

	// Contract 6: sdktrace.WithBatcher registers a batch span processor to asynchronously batch and export spans
	tp := sdktrace.NewTracerProvider(
		sdktrace.WithSpanProcessor(bsp),
		sdktrace.WithSampler(parentSampler),
		sdktrace.WithSpanLimits(customLimits),
	)
	if tp == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected non-nil TracerProvider from NewTracerProvider()")
		os.Exit(1)
	}

	tracer := tp.Tracer("contract-batch-tracer")

	// Test span limits enforcement
	_, span := tracer.Start(ctx, "contract-span-with-limits")
	span.SetAttributes(
		attribute.String("k1", "v1"),
		attribute.String("k2", "v2"),
		attribute.String("k3", "v3"),
	)
	span.AddEvent("event-1")
	span.AddEvent("event-2")
	span.End()

	// ForceFlush forces batch span processor to export queued spans immediately
	if err := tp.ForceFlush(ctx); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: ForceFlush failed: %v\n", err)
		os.Exit(1)
	}

	spans := exporter.GetSpans()
	if len(spans) != 1 {
		fmt.Fprintf(os.Stderr, "FAIL: expected 1 exported span, got %d\n", len(spans))
		os.Exit(1)
	}

	exportedSpan := spans[0]
	if len(exportedSpan.Attributes) != 2 {
		fmt.Fprintf(os.Stderr, "FAIL: expected exactly 2 attributes due to limit, got %d\n", len(exportedSpan.Attributes))
		os.Exit(1)
	}

	if len(exportedSpan.Events) != 1 {
		fmt.Fprintf(os.Stderr, "FAIL: expected exactly 1 event due to limit, got %d\n", len(exportedSpan.Events))
		os.Exit(1)
	}

	// Test ParentBased sampling behavior
	{
		parentExp := tracetest.NewInMemoryExporter()
		neverRootTP := sdktrace.NewTracerProvider(
			sdktrace.WithSyncer(parentExp),
			sdktrace.WithSampler(sdktrace.ParentBased(sdktrace.NeverSample())),
		)
		pTracer := neverRootTP.Tracer("parent-test-tracer")

		// Root span without parent context: should not be sampled
		_, rootSpan := pTracer.Start(ctx, "unsampled-root")
		if rootSpan.SpanContext().IsSampled() {
			fmt.Fprintln(os.Stderr, "FAIL: expected root span to be unsampled under ParentBased(NeverSample)")
			os.Exit(1)
		}
		rootSpan.End()

		// Child span with sampled remote parent: should be sampled
		remoteSampledCtx := trace.NewSpanContext(trace.SpanContextConfig{
			TraceID:    trace.TraceID{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16},
			SpanID:     trace.SpanID{1, 2, 3, 4, 5, 6, 7, 8},
			TraceFlags: trace.FlagsSampled,
			Remote:     true,
		})
		childCtx := trace.ContextWithRemoteSpanContext(ctx, remoteSampledCtx)
		_, childSpan := pTracer.Start(childCtx, "sampled-child")
		if !childSpan.SpanContext().IsSampled() {
			fmt.Fprintln(os.Stderr, "FAIL: expected child span with sampled remote parent to be sampled")
			os.Exit(1)
		}
		childSpan.End()

		if err := neverRootTP.Shutdown(ctx); err != nil {
			fmt.Fprintf(os.Stderr, "FAIL: neverRootTP.Shutdown failed: %v\n", err)
			os.Exit(1)
		}
	}

	// Verify WithBatcher option directly
	{
		batchExp := tracetest.NewInMemoryExporter()
		batchTP := sdktrace.NewTracerProvider(
			sdktrace.WithBatcher(batchExp, sdktrace.WithBatchTimeout(50*time.Millisecond)),
		)
		bTracer := batchTP.Tracer("with-batcher-tracer")
		_, bSpan := bTracer.Start(ctx, "batcher-option-span")
		bSpan.End()

		if err := batchTP.ForceFlush(ctx); err != nil {
			fmt.Fprintf(os.Stderr, "FAIL: WithBatcher ForceFlush failed: %v\n", err)
			os.Exit(1)
		}

		if len(batchExp.GetSpans()) != 1 {
			fmt.Fprintf(os.Stderr, "FAIL: expected 1 span exported via WithBatcher, got %d\n", len(batchExp.GetSpans()))
			os.Exit(1)
		}

		if err := batchTP.Shutdown(ctx); err != nil {
			fmt.Fprintf(os.Stderr, "FAIL: batchTP.Shutdown failed: %v\n", err)
			os.Exit(1)
		}
	}

	if err := tp.Shutdown(ctx); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: tp.Shutdown failed: %v\n", err)
		os.Exit(1)
	}

	fmt.Println("PASS: pkg:golang/go.opentelemetry.io/otel/sdk@v1.43.0 contract verified")
}