Stabilize part of SDK spec for synchronous instrument Enabled#4787
Stabilize part of SDK spec for synchronous instrument Enabled#4787carlosalberto merged 9 commits intoopen-telemetry:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes the specification language around eventual visibility of configuration changes for the Enabled method across all OpenTelemetry signals (traces, metrics, and logs). The changes ensure consistent wording and placement of visibility guarantees while clarifying that metrics specifications apply specifically to synchronous instruments.
- Generalized the visibility statement from referencing specific parameters to "any of these parameters"
- Added clarification that metrics
EnabledSDK specification applies to synchronous instruments - Moved and consolidated visibility guarantees to eliminate duplication
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| specification/trace/sdk.md | De-indented visibility statement in TracerConfig to apply to all parameters at section level |
| specification/metrics/sdk.md | Added visibility statement to MeterConfig, clarified synchronous instrument scope, added inline status annotation to first condition, and removed duplicate visibility text |
| CHANGELOG.md | Added changelog entry documenting the stabilization of part of the Enabled SDK for synchronous instruments |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Is this something we should wait to include in the January's release? |
I think this one should be high confidence and low risk, I suggest that we merge. |
|
@reyang You mean for this month's release (happening later today)? |
|
Let's play it on the defensive side and include this in the next release (January). IMHO no need to rush and include in today's (December) release. |
### Metrics - Stabilize part of `Enabled` SDK for synchronous instruments. ([open-telemetry#4787](open-telemetry#4787)) ### Logs - Add optional Ergonomic API. ([open-telemetry#4741](open-telemetry#4741)) ### SDK Configuration - Declarative configuration: clarify default behavior and validation requirements of `create` and `parse`. ([open-telemetry#4780](open-telemetry#4780)) - Declarative configuration: add optional programmatic customization to `create`, and add related supplemental guidelines. ([open-telemetry#4777](open-telemetry#4777)) - Declarative configuration: add links between SDK extension plugins and corresponding declarative config types. ([open-telemetry#4802](open-telemetry#4802)) - Declarative configuration: clarify Registry ComponentProvider `type` parameter ([open-telemetry#4799](open-telemetry#4799)) ### Common - Stabilize complex `AnyValue` attribute value types and related attribute limits. ([open-telemetry#4794](open-telemetry#4794))
Per #4746 (review)
Side note. I also made sure that this wording used for all signals (and in the same place)
so that the spec is similar for all signals