From 17105ac532f8cb2746bce6f15c9e867432efd248 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Sun, 13 Sep 2020 20:36:14 -0700 Subject: [PATCH 1/3] Add OTEL_EXPORTER environment variable --- spec-compliance-matrix.md | 1 + specification/sdk-environment-variables.md | 28 +++++++++++++++------- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index 1cb5d4dd5b9..8be667af297 100644 --- a/spec-compliance-matrix.md +++ b/spec-compliance-matrix.md @@ -110,6 +110,7 @@ status of the feature is not known. |OTEL_EXPORTER_OTLP_* | | | | - | | - | | | - | - | |OTEL_EXPORTER_JAEGER_* | | | | - | | - | | | - | - | |OTEL_EXPORTER_ZIPKIN_* | | | | + | | - | | | - | - | +|OTEL_EXPORTER | | | | | | | | | | | ## Exporters diff --git a/specification/sdk-environment-variables.md b/specification/sdk-environment-variables.md index 6a6b6f1c084..62f051be9c4 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -19,19 +19,25 @@ The goal of this specification is to unify the environment variable names betwee | OTEL_BSP_MAX_QUEUE_SIZE | Maximum queue size | 2048 | | | OTEL_BSP_MAX_EXPORT_BATCH_SIZE | Maximum batch size | 512 | Must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE | +## OTLP Exporters + +| Name | Description | Default | +| --------------------------- | ----------------------------------------------- | ------- | +| OTEL_EXPORTER_OTLP_ENDPOINT | Ingest endpoint for both OTLP spans and metrics | - | + ## OTLP Span Exporter -| Name | Description | Default | -| -------------------------------- | ------------------------------------------ | ------- | -| OTEL_EXPORTER_OTLP_SPAN_TIMEOUT | Max waiting time to export each span batch | - | -| OTEL_EXPORTER_OTLP_SPAN_ENDPOINT | Ingest endpoint for OTLP spans | - | +| Name | Description | Default | Notes | +| -------------------------------- | ------------------------------------------ | ------- | -------------------------------------------------- | +| OTEL_EXPORTER_OTLP_SPAN_TIMEOUT | Max waiting time to export each span batch | - | | +| OTEL_EXPORTER_OTLP_SPAN_ENDPOINT | Ingest endpoint for OTLP spans | - | Overrides OTEL_EXPORTER_OTLP_ENDPOINT if non-empty | ## OTLP Metric Exporter -| Name | Description | Default | -| ---------------------------------- | -------------------------------------------- | ------- | -| OTEL_EXPORTER_OTLP_METRIC_TIMEOUT | Max waiting time to export each metric batch | - | -| OTEL_EXPORTER_OTLP_METRIC_ENDPOINT | Ingest endpoint for OTLP metrics | - | +| Name | Description | Default | Notes | +| ---------------------------------- | -------------------------------------------- | ------- | -------------------------------------------------- | +| OTEL_EXPORTER_OTLP_METRIC_TIMEOUT | Max waiting time to export each metric batch | - | | +| OTEL_EXPORTER_OTLP_METRIC_ENDPOINT | Ingest endpoint for OTLP metrics | - | Overrides OTEL_EXPORTER_OTLP_ENDPOINT if non-empty | ## Jaeger Exporter @@ -49,6 +55,12 @@ The goal of this specification is to unify the environment variable names betwee | ----------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------ | | OTEL_EXPORTER_ZIPKIN_ENDPOINT | Endpoint for Zipkin traces | "http://localhost:9411/api/v2/spans" | +## Exporter Selection + +| Name | Description | Default | Notes | +| ------------- | ---------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ | +| OTEL_EXPORTER | Exporter to be used, can be a comma-separated list to use multiple exporters | "otlp" | Other known values: "jaeger", "zipkin", "otlp_span", "otlp_metric" | + ## Language Specific Environment Variables To ensure consistent naming across projects, this specification recommends that language specific environment variables are formed using the following convention: From b44b886e2bbb00cd65ce910d65ebec3888a41eba Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 14 Sep 2020 20:48:59 -0700 Subject: [PATCH 2/3] feedback --- specification/sdk-environment-variables.md | 28 ++++++---------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/specification/sdk-environment-variables.md b/specification/sdk-environment-variables.md index 62f051be9c4..011abe88bc0 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -19,25 +19,9 @@ The goal of this specification is to unify the environment variable names betwee | OTEL_BSP_MAX_QUEUE_SIZE | Maximum queue size | 2048 | | | OTEL_BSP_MAX_EXPORT_BATCH_SIZE | Maximum batch size | 512 | Must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE | -## OTLP Exporters +## OTLP Exporter -| Name | Description | Default | -| --------------------------- | ----------------------------------------------- | ------- | -| OTEL_EXPORTER_OTLP_ENDPOINT | Ingest endpoint for both OTLP spans and metrics | - | - -## OTLP Span Exporter - -| Name | Description | Default | Notes | -| -------------------------------- | ------------------------------------------ | ------- | -------------------------------------------------- | -| OTEL_EXPORTER_OTLP_SPAN_TIMEOUT | Max waiting time to export each span batch | - | | -| OTEL_EXPORTER_OTLP_SPAN_ENDPOINT | Ingest endpoint for OTLP spans | - | Overrides OTEL_EXPORTER_OTLP_ENDPOINT if non-empty | - -## OTLP Metric Exporter - -| Name | Description | Default | Notes | -| ---------------------------------- | -------------------------------------------- | ------- | -------------------------------------------------- | -| OTEL_EXPORTER_OTLP_METRIC_TIMEOUT | Max waiting time to export each metric batch | - | | -| OTEL_EXPORTER_OTLP_METRIC_ENDPOINT | Ingest endpoint for OTLP metrics | - | Overrides OTEL_EXPORTER_OTLP_ENDPOINT if non-empty | +See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter.md). ## Jaeger Exporter @@ -57,9 +41,11 @@ The goal of this specification is to unify the environment variable names betwee ## Exporter Selection -| Name | Description | Default | Notes | -| ------------- | ---------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ | -| OTEL_EXPORTER | Exporter to be used, can be a comma-separated list to use multiple exporters | "otlp" | Other known values: "jaeger", "zipkin", "otlp_span", "otlp_metric" | +| Name | Description | Default | +| ------------- | ---------------------------------------------------------------------------- | ------- | +| OTEL_EXPORTER | Exporter to be used, can be a comma-separated list to use multiple exporters | "otlp" | + +Known values for OTEL_EXPORTER are: "otlp", "jaeger", "zipkin", "prometheus", "otlp_span", "otlp_metric". ## Language Specific Environment Variables From db74266c9a31114fe314307088927bef353b02f4 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 14 Sep 2020 21:44:33 -0700 Subject: [PATCH 3/3] Add note about otlp=otlp_span,otlp_metric --- specification/sdk-environment-variables.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/sdk-environment-variables.md b/specification/sdk-environment-variables.md index 011abe88bc0..557591f0355 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -47,6 +47,8 @@ See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter. Known values for OTEL_EXPORTER are: "otlp", "jaeger", "zipkin", "prometheus", "otlp_span", "otlp_metric". +Note: "otlp" is equivalent to "otlp_span,otlp_metric". + ## Language Specific Environment Variables To ensure consistent naming across projects, this specification recommends that language specific environment variables are formed using the following convention: