go.opentelemetry.io/otel/trace v1.44.0: WithInstrumentationVersion

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/trace.WithInstrumentationVersion in pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0
Demonstrate these symbols/APIs:
  - go.opentelemetry.io/otel/trace.WithInstrumentationVersion
Required runtime conditions:
  - ecosystem: golang
  - language: go
  - packageManager: go@1.26.6
  - runtime: go@1.26.6

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:b6c1102fc24f849139a9d669ac1d41eeefc6081d252ed69c206c97092027eded","contract":["WithInstrumentationVersion sets instrumentation version on TracerConfig","TracerConfig defaults to empty instrumentation version when WithInstrumentationVersion is omitted","WithInstrumentationVersion overwrites previous version when multiple options provided","TracerProvider creates Tracer using WithInstrumentationVersion option","Tracer created with WithInstrumentationVersion starts spans successfully"],"goal":"verify go.opentelemetry.io/otel/trace.WithInstrumentationVersion in pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0","kind":"HOW","packages":["pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0"],"schemaVersion":1,"symbols":["go.opentelemetry.io/otel/trace.WithInstrumentationVersion"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0"],"schemaVersion":1,"subject":"pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0","symbols":["go.opentelemetry.io/otel/trace.WithInstrumentationVersion"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require go.opentelemetry.io/otel/trace v1.44.0

require (
	github.com/cespare/xxhash/v2 v2.3.0 // indirect
	go.opentelemetry.io/otel v1.44.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/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
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/otel v1.44.0 h1:JjwHmHpA4iZ3wBxluu2fbbE7j4kqlE8jXyAyPXH7HqU=
go.opentelemetry.io/otel v1.44.0/go.mod h1:BMgjTHL9WPRlRjL2oZCBTL4whCGtXch2H4BhOPIAyYc=
go.opentelemetry.io/otel/trace v1.44.0 h1:jxF5CsGYCe74MCRx2X4g7WsY/VBKRqqpNvXlX/6gtIk=
go.opentelemetry.io/otel/trace v1.44.0/go.mod h1:oLl1jrMQAVo6v3GAggN+1VH9VIz9iUSvW53sW1Q8PIE=
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"

	"go.opentelemetry.io/otel/trace"
	"go.opentelemetry.io/otel/trace/noop"
)

// NewConfiguredTracer creates a Tracer from a TracerProvider configured with an instrumentation version.
func NewConfiguredTracer(tp trace.TracerProvider, name string, version string) trace.Tracer {
	if tp == nil {
		tp = noop.NewTracerProvider()
	}
	return tp.Tracer(name, trace.WithInstrumentationVersion(version))
}

// GetTracerVersion extracts the configured instrumentation version from TracerOptions.
func GetTracerVersion(options ...trace.TracerOption) string {
	cfg := trace.NewTracerConfig(options...)
	return cfg.InstrumentationVersion()
}

// StartTracedOperation starts a span using the provided Tracer.
func StartTracedOperation(ctx context.Context, tr trace.Tracer, spanName string) (context.Context, trace.Span) {
	if tr == nil {
		tr = noop.NewTracerProvider().Tracer("default")
	}
	return tr.Start(ctx, spanName)
}

{
  "schemaVersion": 1,
  "goal": "verify go.opentelemetry.io/otel/trace.WithInstrumentationVersion in pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/go.opentelemetry.io/otel/trace@v1.44.0"
  ],
  "symbols": [
    "go.opentelemetry.io/otel/trace.WithInstrumentationVersion"
  ],
  "runtimeConditions": {
    "ecosystem": "golang",
    "language": "go",
    "packageManager": "go@1.26.6",
    "runtime": "go@1.26.6"
  }
}

package main

import (
	"context"
	"fmt"
	"os"

	"go.opentelemetry.io/otel/trace"
	"go.opentelemetry.io/otel/trace/noop"
	"sample"
)

func main() {
	if err := runTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All OpenTelemetry trace WithInstrumentationVersion contract tests passed successfully.")
}

func runTests() error {
	ctx := context.Background()

	// 1. WithInstrumentationVersion sets instrumentation version on TracerConfig
	const expectedVersion = "1.44.0"
	cfg := trace.NewTracerConfig(trace.WithInstrumentationVersion(expectedVersion))
	if got := cfg.InstrumentationVersion(); got != expectedVersion {
		return fmt.Errorf("TracerConfig instrumentation version mismatch: got %q, want %q", got, expectedVersion)
	}

	// 2. TracerConfig defaults to empty instrumentation version when WithInstrumentationVersion is omitted
	defaultCfg := trace.NewTracerConfig()
	if got := defaultCfg.InstrumentationVersion(); got != "" {
		return fmt.Errorf("default TracerConfig instrumentation version should be empty, got %q", got)
	}

	// 3. WithInstrumentationVersion overwrites previous version when multiple options provided
	const overriddenVersion = "2.0.0"
	multiCfg := trace.NewTracerConfig(
		trace.WithInstrumentationVersion("1.0.0"),
		trace.WithInstrumentationVersion(overriddenVersion),
	)
	if got := multiCfg.InstrumentationVersion(); got != overriddenVersion {
		return fmt.Errorf("TracerConfig with multiple options should have latest version: got %q, want %q", got, overriddenVersion)
	}

	// 4. TracerProvider creates Tracer using WithInstrumentationVersion option
	tp := noop.NewTracerProvider()
	tracer := sample.NewConfiguredTracer(tp, "example.com/component", expectedVersion)
	if tracer == nil {
		return fmt.Errorf("expected non-nil Tracer from NewConfiguredTracer")
	}

	// 5. Tracer created with WithInstrumentationVersion starts spans successfully
	spCtx, span := sample.StartTracedOperation(ctx, tracer, "sample-operation")
	if span == nil {
		return fmt.Errorf("expected non-nil Span from StartTracedOperation")
	}
	defer span.End()

	if spCtx == nil {
		return fmt.Errorf("expected non-nil Context from StartTracedOperation")
	}

	// Also verify helper function GetTracerVersion
	if got := sample.GetTracerVersion(trace.WithInstrumentationVersion(expectedVersion)); got != expectedVersion {
		return fmt.Errorf("GetTracerVersion mismatch: got %q, want %q", got, expectedVersion)
	}

	return nil
}