diff --git a/specification/sdk-environment-variables.md b/specification/sdk-environment-variables.md index ebeb4c2db4e..5cbe2a7bf6a 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -1,9 +1,13 @@ # OpenTelemetry Environment Variable Specification +**Status**: [Mixed](document-status.md) + The goal of this specification is to unify the environment variable names between different OpenTelemetry SDK implementations. SDKs MAY choose to allow configuration via the environment variables in this specification, but are not required to. If they do, they SHOULD use the names listed in this document. ## Special configuration types +**Status**: [Stable](document-status.md) + ### Numeric value If an SDK chooses to support an integer-valued environment variable, it SHOULD support nonnegative values between 0 and 2³¹ − 1 (inclusive). Individual SDKs MAY choose to support a larger range of values. @@ -23,6 +27,8 @@ For example, the value `12000` indicates 12000 milliseconds, i.e., 12 seconds. ## General SDK Configuration +**Status**: [Stable](document-status.md) + | Name | Description | Default | Notes | | ------------------------ | ------------------------------------------------- | --------------------------------- | ----------------------------------- | | OTEL_RESOURCE_ATTRIBUTES | Key-value pairs to be used as resource attributes | | See [Resource SDK](./resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. | @@ -56,6 +62,8 @@ Depending on the value of `OTEL_TRACES_SAMPLER`, `OTEL_TRACES_SAMPLER_ARG` may b ## Batch Span Processor +**Status**: [Stable](document-status.md) + | Name | Description | Default | Notes | | ------------------------------ | ---------------------------------------------- | ------- | ----------------------------------------------------- | | OTEL_BSP_SCHEDULE_DELAY | Delay interval between two consecutive exports | 5000 | | @@ -65,6 +73,8 @@ Depending on the value of `OTEL_TRACES_SAMPLER`, `OTEL_TRACES_SAMPLER_ARG` may b ## Span Collection Limits +**Status**: [Experimental](document-status.md) + | Name | Description | Default | Notes | | ------------------------------- | ------------------------------------ | ------- | ----- | | OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | Maximum allowed span attribute count | 1000 | | @@ -77,6 +87,8 @@ See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter. ## Jaeger Exporter +**Status**: [Stable](document-status.md) + | Name | Description | Default | | ------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | OTEL_EXPORTER_JAEGER_AGENT_HOST | Hostname for the Jaeger agent | "localhost" | @@ -87,6 +99,8 @@ See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter. ## Zipkin Exporter +**Status**: [Stable](document-status.md) + | Name | Description | Default | | ----------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------ | | OTEL_EXPORTER_ZIPKIN_ENDPOINT | Endpoint for Zipkin traces | "http://localhost:9411/api/v2/spans" | @@ -102,6 +116,8 @@ thrift or protobuf. As of 1.0 of the specification, there ## Prometheus Exporter +**Status**: [Experimental](document-status.md) + | Name | Description | Default | | ----------------------------- | --------------------------------| ---------------------------- | | OTEL_EXPORTER_PROMETHEUS_HOST | Host used by the Prometheus exporter | All addresses: "0.0.0.0"| @@ -109,6 +125,8 @@ thrift or protobuf. As of 1.0 of the specification, there ## Exporter Selection +**Status**: [Stable](document-status.md) + We define environment variables for setting a single exporter per signal. | Name | Description | Default |