trace,metric,log: add WithInstrumentationAttributeSet option

[pellared]

Per #7266 (comment)

Related to #7217

What

This PR adds WithInstrumentationAttributeSet option functions to the log, metric, and trace packages as suggested in #7266 (comment). These new functions provide a more concurrent-safe alternative to the existing WithInstrumentationAttributes functions by accepting a pre-constructed attribute.Set instead of variadic attribute.KeyValue parameters.

Why

As discussed in #7266, the existing WithInstrumentationAttributes functions can lead to data races when used concurrently because attribute.NewSet() may mutate the passed slice in-place. While the issue was partially addressed by moving the attribute.NewSet() call outside the closure, the best long-term solution is to provide an alternative that accepts an immutable attribute.Set.

Benefits:

1. Concurrent Safety: Since attribute.Set is immutable, these functions are inherently safe for concurrent use
2. Performance: Avoids repeated calls to attribute.NewSet() when the same attributes are used multiple times
3. Consistency: Matches the existing pattern used in metric.WithAttributeSet()
4. Flexibility: Allows users to pre-compute attribute sets and reuse them

Deprecating WithInstrumentationAttributes is out of scope. See #7287 (comment).

Benchmarks

goos: linux
goarch: amd64
pkg: go.opentelemetry.io/otel/trace
cpu: 13th Gen Intel(R) Core(TM) i7-13800H
BenchmarkNewTracerConfig/with_no_options-20         	280298306	         4.268 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewTracerConfig/with_an_instrumentation_version-20         	33389427	        30.84 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewTracerConfig/with_a_schema_url-20                       	35441077	        30.46 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewTracerConfig/with_instrumentation_attribute-20          	17607649	        88.23 ns/op	      64 B/op	       1 allocs/op
BenchmarkNewTracerConfig/with_instrumentation_attribute_set-20      	38336211	        31.30 ns/op	       0 B/op	       0 allocs/op

goos: linux
goarch: amd64
pkg: go.opentelemetry.io/otel/metric
cpu: 13th Gen Intel(R) Core(TM) i7-13800H
BenchmarkNewMeterConfig/with_no_options-20         	262998199	         4.525 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewMeterConfig/with_an_instrumentation_version-20         	40483780	        29.31 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewMeterConfig/with_a_schema_url-20                       	39162420	        30.58 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewMeterConfig/with_instrumentation_attribute-20          	19900275	        77.50 ns/op	      64 B/op	       1 allocs/op
BenchmarkNewMeterConfig/with_instrumentation_attribute_set-20      	37519020	        31.93 ns/op	       0 B/op	       0 allocs/op

goos: linux
goarch: amd64
pkg: go.opentelemetry.io/otel/log
cpu: 13th Gen Intel(R) Core(TM) i7-13800H
BenchmarkNewLoggerConfig/with_no_options-20         	271100760	         4.322 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewLoggerConfig/with_an_instrumentation_version-20         	38392390	        30.77 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewLoggerConfig/with_a_schema_url-20                       	39615074	        30.25 ns/op	       0 B/op	       0 allocs/op
BenchmarkNewLoggerConfig/with_instrumentation_attribute-20          	17108463	        82.51 ns/op	      64 B/op	       1 allocs/op
BenchmarkNewLoggerConfig/with_instrumentation_attribute_set-20      	37746534	        31.70 ns/op	       0 B/op	       0 allocs/op

[pellared]

@axw PTAL

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.9%. Comparing base (b335c07) to head (670f753).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #7287   +/-   ##
=====================================
  Coverage   82.9%   82.9%           
=====================================
  Files        266     266           
  Lines      24948   24984   +36     
=====================================
+ Hits       20698   20734   +36     
  Misses      3875    3875           
  Partials     375     375           

Files with missing lines	Coverage Δ
log/logger.go	100.0% <100.0%> (ø)
metric/config.go	100.0% <100.0%> (ø)
trace/config.go	97.1% <100.0%> (+0.2%)	⬆️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[axw]

Looks good :)

[dashpole]

Should we deprecate WithInstrumentationAttributes and point users toward WithInstrumentationAttributeSet? As a user it isn't clear which I should use, and this seems to be a safer+better option.

[pellared]

Should we deprecate WithInstrumentationAttributes and point users toward WithInstrumentationAttributeSet? As a user it isn't clear which I should use, and this seems to be a safer+better option.

I was thinking about it as well! Especially that I do not think there are a lot of usages of WithInstrumentationAttributes. However, then I started to think whether we should not do the same for metric.WithAttributes options? People would probably get a lot of "deprecation" notices and I am not sure how users would react.

I have double-check if there is a performance difference between:

attrs := attribute.NewSet(attribute.String("service", "test"))
trace.NewTracerConfig(
	metric.WithInstrumentationAttributeSet(attrs),
)

and

trace.NewTracerConfig(
	trace.WithInstrumentationAttributes(attribute.String("service", "test")),
)

BenchmarkNewTracerConfig/with_instrumentation_attribute-20          	20058529	        98.83 ns/op	      64 B/op	       1 allocs/op
BenchmarkNewTracerConfig/with_instrumentation_attribute_set-20      	44130600	        27.41 ns/op	       0 B/op	       0 allocs/op

Still, I would rather do it a separate PR as I think this is a little subjective whether it should be deprecated or not. It would be also easier to "revert commit" if we change our mind that deprecating WithInstrumentationAttributes was a bad idea.

Also please see (including conversations): #7266

EDIT:
I added a benchmark case (498e059) and added notes to the GoDoc comments (492dfd6).

[dashpole]

I'm OK with deferring discussions about deprecating the non-set option.

[MrAlias]

We want to support setting attributes with multiple options. WithInstrumentaitonAttributeSet should not clear any previously set attributes, and similar for `WithInstrumentationAttributes.

[pellared]

We want to support setting attributes with multiple options. WithInstrumentaitonAttributeSet should not clear any previously set attributes, and similar for `WithInstrumentationAttributes.

This would be a breaking behavioral change for WithInstrumentationAttribute. However, I think it could be considered as a bugix. How about scoping it to a separate PR?

[MrAlias]

This would be a breaking behavioral change for WithInstrumentationAttribute. However, I think it could be considered as a bugix. How about scoping it to a separate PR?

I'm find scoping the fix to WithInstrumentationAttribute to its own PR.

However, I'm hesitant to add another option that also contains this bug. Especially since it is adding a conflicting way to set the same value as an existing option.

[pellared]

I'm fine scoping the fix to WithInstrumentationAttributes to its own PR.
However, I'm hesitant to add another option that also contains this bug.

Let's fix WithInstrumentationAttributes first 👍

[pellared]

#7300 is merged and this PR is updated (comments addressed).

EDIT: I also added benchmarks to showcase the performance benefits.

[Copilot]

Pull Request Overview

This PR adds WithInstrumentationAttributeSet option functions to the log, metric, and trace packages to provide a concurrent-safe alternative to the existing WithInstrumentationAttributes functions by accepting pre-constructed attribute.Set instead of variadic attribute.KeyValue parameters.

• Adds new WithInstrumentationAttributeSet functions that accept attribute.Set for better concurrency safety and performance
• Updates documentation for existing WithInstrumentationAttributes functions to recommend the new alternative
• Implements comprehensive test coverage including merge behavior and benchmarks

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
trace/config.go	Adds WithInstrumentationAttributeSet function and updates documentation
trace/config_test.go	Adds tests and benchmarks for the new function
metric/config.go	Adds WithInstrumentationAttributeSet function and updates documentation
metric/config_test.go	Adds tests and benchmarks for the new function
log/logger.go	Adds WithInstrumentationAttributeSet function and updates documentation
log/logger_test.go	Adds tests and benchmarks for the new function
CHANGELOG.md	Documents the new feature addition

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}