From 5035e829bf554db07e81f27bd23d81c1d5982fb3 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 16 Sep 2020 10:38:15 -0700 Subject: [PATCH] Add OTEL_EXPORTER environment variable (#943) * Add OTEL_EXPORTER environment variable * feedback * Add note about otlp=otlp_span,otlp_metric --- spec-compliance-matrix.md | 1 + specification/sdk-environment-variables.md | 24 +++++++++++----------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index 3c7968053fc..329d2c17f59 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..557591f0355 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -19,19 +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 Span Exporter +## OTLP 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 | - | - -## 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 | - | +See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter.md). ## Jaeger Exporter @@ -49,6 +39,16 @@ 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 | +| ------------- | ---------------------------------------------------------------------------- | ------- | +| 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". + +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: