mirror of
1
Fork 0
gotosocial/vendor/go.opentelemetry.io/otel/sdk/internal/x/README.md

2.0 KiB

Experimental Features

The SDK contains features that have not yet stabilized in the OpenTelemetry specification. 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.

These feature may change in backwards incompatible ways as feedback is applied. See the Compatibility and Stability section for more information.

Features

Resource

OpenTelemetry resource semantic conventions include many attribute definitions that are defined as experimental. To have experimental semantic conventions be added by resource detectors set the OTEL_GO_X_RESOURCE environment variable. The value set must be the case-insensitive string of "true" to enable the feature. All other values are ignored.

Examples

Enable experimental resource semantic conventions.

export OTEL_GO_X_RESOURCE=true

Disable experimental resource semantic conventions.

unset OTEL_GO_X_RESOURCE

Compatibility and Stability

Experimental features do not fall within the scope of the OpenTelemetry Go versioning and stability policy. These features may be removed or modified in successive version releases, including patch versions.

When an experimental feature is promoted to a stable feature, a migration path will be included in the changelog entry of the release. There is no guarantee that any environment variable feature flags that enabled the experimental feature will be supported by the stable version. If they are supported, they may be accompanied with a deprecation notice stating a timeline for the removal of that support.