Add support for the development attributes advisory parameter

dashpole · dashpole · commit 68d0d53b85af · 2026-04-06T18:43:16.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Added
+
+- Add `WithDefaultAttributes` to `go.opentelemetry.io/otel/metric/x` to support setting default attributes on instruments. (#8135)
+
 <!-- Released section -->
 <!-- Don't change this section unless doing release -->
 
diff --git a/bridge/opencensus/go.mod b/bridge/opencensus/go.mod
@@ -34,3 +34,5 @@ replace go.opentelemetry.io/otel/sdk => ../../sdk
 replace go.opentelemetry.io/otel/metric => ../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../metric/x
diff --git a/bridge/opencensus/test/go.mod b/bridge/opencensus/test/go.mod
@@ -33,3 +33,5 @@ replace go.opentelemetry.io/otel/trace => ../../../trace
 replace go.opentelemetry.io/otel/metric => ../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/exporters/otlp/otlplog/otlploggrpc/go.mod b/exporters/otlp/otlplog/otlploggrpc/go.mod
@@ -54,3 +54,5 @@ replace go.opentelemetry.io/otel/metric => ../../../../metric
 replace go.opentelemetry.io/otel/sdk/log/logtest => ../../../../sdk/log/logtest
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/otlp/otlplog/otlploghttp/go.mod b/exporters/otlp/otlplog/otlploghttp/go.mod
@@ -54,3 +54,5 @@ replace go.opentelemetry.io/otel/metric => ../../../../metric
 replace go.opentelemetry.io/otel/log => ../../../../log
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/otlp/otlpmetric/otlpmetricgrpc/go.mod b/exporters/otlp/otlpmetric/otlpmetricgrpc/go.mod
@@ -44,3 +44,5 @@ replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
 replace go.opentelemetry.io/otel/metric => ../../../../metric
 
 replace go.opentelemetry.io/otel/trace => ../../../../trace
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/otlp/otlpmetric/otlpmetrichttp/go.mod b/exporters/otlp/otlpmetric/otlpmetrichttp/go.mod
@@ -44,3 +44,5 @@ replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
 replace go.opentelemetry.io/otel/metric => ../../../../metric
 
 replace go.opentelemetry.io/otel/trace => ../../../../trace
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/otlp/otlptrace/go.mod b/exporters/otlp/otlptrace/go.mod
@@ -34,3 +34,5 @@ replace go.opentelemetry.io/otel/trace => ../../../trace
 replace go.opentelemetry.io/otel/metric => ../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/exporters/otlp/otlptrace/otlptracegrpc/go.mod b/exporters/otlp/otlptrace/otlptracegrpc/go.mod
@@ -45,3 +45,5 @@ replace go.opentelemetry.io/otel/trace => ../../../../trace
 replace go.opentelemetry.io/otel/metric => ../../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/otlp/otlptrace/otlptracehttp/go.mod b/exporters/otlp/otlptrace/otlptracehttp/go.mod
@@ -44,3 +44,5 @@ replace go.opentelemetry.io/otel/trace => ../../../../trace
 replace go.opentelemetry.io/otel/metric => ../../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../../metric/x
diff --git a/exporters/prometheus/go.mod b/exporters/prometheus/go.mod
@@ -46,3 +46,5 @@ replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric
 replace go.opentelemetry.io/otel/trace => ../../trace
 
 replace go.opentelemetry.io/otel/metric => ../../metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../metric/x
diff --git a/exporters/stdout/stdoutlog/go.mod b/exporters/stdout/stdoutlog/go.mod
@@ -44,3 +44,5 @@ replace go.opentelemetry.io/otel/sdk => ../../../sdk
 replace go.opentelemetry.io/otel/metric => ../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/exporters/stdout/stdoutmetric/go.mod b/exporters/stdout/stdoutmetric/go.mod
@@ -32,3 +32,5 @@ replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric
 replace go.opentelemetry.io/otel/trace => ../../../trace
 
 replace go.opentelemetry.io/otel/sdk => ../../../sdk
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/exporters/stdout/stdouttrace/go.mod b/exporters/stdout/stdouttrace/go.mod
@@ -33,3 +33,5 @@ replace go.opentelemetry.io/otel/trace => ../../../trace
 replace go.opentelemetry.io/otel/metric => ../../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/exporters/zipkin/go.mod b/exporters/zipkin/go.mod
@@ -35,3 +35,5 @@ replace go.opentelemetry.io/otel/sdk => ../../sdk
 replace go.opentelemetry.io/otel/metric => ../../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../metric/x
diff --git a/metric/x/README.md b/metric/x/README.md
@@ -0,0 +1,5 @@
+# Experimental Metric Options
+
+This package contains experimental options for the OpenTelemetry metric package.
+These options are currently under development and not part of the stable API.
+They may be changed in backwards-incompatible ways, or removed entirely.
diff --git a/metric/x/go.mod b/metric/x/go.mod
@@ -0,0 +1,16 @@
+module go.opentelemetry.io/otel/metric/x
+
+go 1.25.0
+
+require (
+	go.opentelemetry.io/otel v1.43.0
+	go.opentelemetry.io/otel/metric v1.43.0
+)
+
+require github.com/cespare/xxhash/v2 v2.3.0 // indirect
+
+replace go.opentelemetry.io/otel/metric => ../../metric
+
+replace go.opentelemetry.io/otel/trace => ../../trace
+
+replace go.opentelemetry.io/otel => ../..
diff --git a/metric/x/go.sum b/metric/x/go.sum
@@ -0,0 +1,18 @@
+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.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/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=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/metric/x/options.go b/metric/x/options.go
@@ -0,0 +1,27 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Package x contains experimental metric options.
+package x // import "go.opentelemetry.io/otel/metric/x"
+
+import (
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/metric"
+)
+
+type defaultAttributesOption struct {
+	metric.InstrumentOption
+	keys []attribute.Key
+}
+
+// Experimental prevents the API from panicking when the option is used.
+func (defaultAttributesOption) Experimental() {}
+
+func (o defaultAttributesOption) AllowedKeys() []attribute.Key {
+	return o.keys
+}
+
+// WithDefaultAttributes returns a metric.InstrumentOption that specifies default attribute keys.
+func WithDefaultAttributes(keys ...attribute.Key) metric.InstrumentOption {
+	return defaultAttributesOption{keys: keys}
+}
diff --git a/sdk/go.mod b/sdk/go.mod
@@ -31,3 +31,5 @@ replace go.opentelemetry.io/otel/trace => ../trace
 replace go.opentelemetry.io/otel/metric => ../metric
 
 replace go.opentelemetry.io/otel/sdk/metric => ./metric
+
+replace go.opentelemetry.io/otel/metric/x => ../metric/x
diff --git a/sdk/log/go.mod b/sdk/log/go.mod
@@ -36,3 +36,5 @@ replace go.opentelemetry.io/otel/log => ../../log
 replace go.opentelemetry.io/otel => ../..
 
 replace go.opentelemetry.io/otel/sdk/metric => ../metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../metric/x
diff --git a/sdk/log/logtest/go.mod b/sdk/log/logtest/go.mod
@@ -37,3 +37,5 @@ replace go.opentelemetry.io/otel/log => ../../../log
 replace go.opentelemetry.io/otel => ../../..
 
 replace go.opentelemetry.io/otel/sdk/metric => ../../metric
+
+replace go.opentelemetry.io/otel/metric/x => ../../../metric/x
diff --git a/sdk/metric/go.mod b/sdk/metric/go.mod
@@ -9,6 +9,7 @@ require (
 	github.com/stretchr/testify v1.11.1
 	go.opentelemetry.io/otel v1.43.0
 	go.opentelemetry.io/otel/metric v1.43.0
+	go.opentelemetry.io/otel/metric/x v0.0.0-00010101000000-000000000000
 	go.opentelemetry.io/otel/sdk v1.43.0
 	go.opentelemetry.io/otel/trace v1.43.0
 )
@@ -30,3 +31,5 @@ replace go.opentelemetry.io/otel/metric => ../../metric
 replace go.opentelemetry.io/otel/trace => ../../trace
 
 replace go.opentelemetry.io/otel/sdk => ../
+
+replace go.opentelemetry.io/otel/metric/x => ../../metric/x
diff --git a/sdk/metric/meter.go b/sdk/metric/meter.go
diff --git a/sdk/metric/meter_test.go b/sdk/metric/meter_test.go
diff --git a/sdk/metric/pipeline.go b/sdk/metric/pipeline.go
diff --git a/sdk/metric/pipeline_registry_test.go b/sdk/metric/pipeline_registry_test.go
diff --git a/sdk/metric/pipeline_test.go b/sdk/metric/pipeline_test.go
diff --git a/versions.yaml b/versions.yaml
