You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-12-07 23:32:49 +02:00
36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
|
|
# Experimental Features
|
||
|
|
|
||
|
|
The metric SDK contains features that have not yet stabilized in the OpenTelemetry specification.
|
||
|
|
These features are added to the OpenTelemetry Go metric 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](#compatibility-and-stability) section for more information.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- [Self-Observability](#self-observability)
|
||
|
|
|
||
|
|
### Self-Observability
|
||
|
|
|
||
|
|
The SDK provides a self-observability feature that allows you to monitor the SDK itself.
|
||
|
|
|
||
|
|
To opt-in, set the environment variable `OTEL_GO_X_SELF_OBSERVABILITY` to `true`.
|
||
|
|
|
||
|
|
When enabled, the SDK will create the following metrics using the global `MeterProvider`:
|
||
|
|
|
||
|
|
- `otel.sdk.span.live`
|
||
|
|
- `otel.sdk.span.started`
|
||
|
|
|
||
|
|
Please see the [Semantic conventions for OpenTelemetry SDK metrics] documentation for more details on these metrics.
|
||
|
|
|
||
|
|
[Semantic conventions for OpenTelemetry SDK metrics]: https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/otel/sdk-metrics.md
|
||
|
|
|
||
|
|
## Compatibility and Stability
|
||
|
|
|
||
|
|
Experimental features do not fall within the scope of the OpenTelemetry Go versioning and stability [policy](../../../../VERSIONING.md).
|
||
|
|
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.
|