Skip to content

Commit

Permalink
[Blocking 1.0] Add status to environment variables document (#1407)
Browse files Browse the repository at this point in the history
* Add status to environment variables document

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

* Mark span limits experimental

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu authored Feb 9, 2021
1 parent 4c706d7 commit 2349ab4
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions specification/sdk-environment-variables.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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. |
Expand Down Expand Up @@ -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 | |
Expand All @@ -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 | |
Expand All @@ -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" |
Expand All @@ -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 | <!-- markdown-link-check-disable --> "http://localhost:9411/api/v2/spans"<!-- markdown-link-check-enable --> |
Expand All @@ -102,13 +116,17 @@ 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"|
| OTEL_EXPORTER_PROMETHEUS_PORT | Port used by the Prometheus exporter | 9464 |

## Exporter Selection

**Status**: [Stable](document-status.md)

We define environment variables for setting a single exporter per signal.

| Name | Description | Default |
Expand Down

0 comments on commit 2349ab4

Please sign in to comment.