Debian Codegraph @

sdk/internal/x/README.md

raw
1 # Experimental Features
2
3 The SDK contains features that have not yet stabilized in the OpenTelemetry specification.
4 These features are added to the OpenTelemetry Go SDK prior to stabilization in the specification so that users can start experimenting with them and provide feedback.
5
6 These feature may change in backwards incompatible ways as feedback is applied.
7 See the [Compatibility and Stability](#compatibility-and-stability) section for more information.
8
9 ## Features
10
11 - [Resource](#resource)
12
13 ### Resource
14
15 [OpenTelemetry resource semantic conventions] include many attribute definitions that are defined as experimental.
16 To have experimental semantic conventions be added by [resource detectors] set the `OTEL_GO_X_RESOURCE` environment variable.
17 The value set must be the case-insensitive string of `"true"` to enable the feature.
18 All other values are ignored.
19
20 <!-- TODO: document what attributes are added by which detector -->
21
22 [OpenTelemetry resource semantic conventions]: https://opentelemetry.io/docs/specs/semconv/resource/
23 [resource detectors]: https://pkg.go.dev/go.opentelemetry.io/otel/sdk/resource#Detector
24
25 #### Examples
26
27 Enable experimental resource semantic conventions.
28
29 ```console
30 export OTEL_GO_X_RESOURCE=true
31 ```
32
33 Disable experimental resource semantic conventions.
34
35 ```console
36 unset OTEL_GO_X_RESOURCE
37 ```
38
39 ## Compatibility and Stability
40
41 Experimental features do not fall within the scope of the OpenTelemetry Go versioning and stability [policy](../../../VERSIONING.md).
42 These features may be removed or modified in successive version releases, including patch versions.
43
44 When an experimental feature is promoted to a stable feature, a migration path will be included in the changelog entry of the release.
45 There is no guarantee that any environment variable feature flags that enabled the experimental feature will be supported by the stable version.
46 If they are supported, they may be accompanied with a deprecation notice stating a timeline for the removal of that support.