Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 3.65 KB

EXPERIMENTAL.md

File metadata and controls

111 lines (72 loc) · 3.65 KB
Raw

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 section for more information.

Features

Cardinality Limit

The cardinality limit is the hard limit on the number of metric streams that can be collected for a single instrument.

This experimental feature can be enabled by setting the OTEL_GO_X_CARDINALITY_LIMIT environment value. The value must be an integer value. All other values are ignored.

If the value set is less than or equal to 0, no limit will be applied.

Examples

Set the cardinality limit to 2000.

export OTEL_GO_X_CARDINALITY_LIMIT=2000

Set an infinite cardinality limit (functionally equivalent to disabling the feature).

export OTEL_GO_X_CARDINALITY_LIMIT=-1

Disable the cardinality limit.

unset OTEL_GO_X_CARDINALITY_LIMIT

Exemplars

A sample of measurements made may be exported directly as a set of exemplars.

This experimental feature can be enabled by setting the OTEL_GO_X_EXEMPLAR environment variable. The value of must be the case-insensitive string of "true" to enable the feature. All other values are ignored.

Exemplar filters are a supported. The exemplar filter applies to all measurements made. They filter these measurements, only allowing certain measurements to be passed to the underlying exemplar reservoir.

To change the exemplar filter from the default "trace_based" filter set the OTEL_METRICS_EXEMPLAR_FILTER environment variable. The value must be the case-sensitive string defined by the OpenTelemetry specification.

  • "always_on": allows all measurements
  • "always_off": denies all measurements
  • "trace_based": allows only sampled measurements

All values other than these will result in the default, "trace_based", exemplar filter being used.

Examples

Enable exemplars to be exported.

export OTEL_GO_X_EXEMPLAR=true

Disable exemplars from being exported.

unset OTEL_GO_X_EXEMPLAR

Set the exemplar filter to allow all measurements.

export OTEL_METRICS_EXEMPLAR_FILTER=always_on

Set the exemplar filter to deny all measurements.

export OTEL_METRICS_EXEMPLAR_FILTER=always_off

Set the exemplar filter to only allow sampled measurements.

export OTEL_METRICS_EXEMPLAR_FILTER=trace_based

Revert to the default exemplar filter ("trace_based")

unset OTEL_METRICS_EXEMPLAR_FILTER

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.