Skip to content

Commit

Permalink
Add OTEL_EXPORTER environment variable (#943)
Browse files Browse the repository at this point in the history
* Add OTEL_EXPORTER environment variable

* feedback

* Add note about otlp=otlp_span,otlp_metric
  • Loading branch information
trask authored Sep 16, 2020
1 parent 4b6f6e5 commit 5035e82
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions spec-compliance-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ status of the feature is not known.
|OTEL_EXPORTER_OTLP_* | | | | - | | - | - | | - | - |
|OTEL_EXPORTER_JAEGER_* | | | | - | | - | - | | - | - |
|OTEL_EXPORTER_ZIPKIN_* | | | | + | | - | - | | - | - |
|OTEL_EXPORTER | | | | | | | | | | |

## Exporters

Expand Down
24 changes: 12 additions & 12 deletions specification/sdk-environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 | <!-- markdown-link-check-disable --> "http://localhost:9411/api/v2/spans"<!-- markdown-link-check-enable --> |

## 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:
Expand Down

0 comments on commit 5035e82

Please sign in to comment.