Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OTEL_EXPORTER environment variable #943

Merged
merged 4 commits into from
Sep 16, 2020
Merged

Add OTEL_EXPORTER environment variable #943

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17105ac
Add OTEL_EXPORTER environment variable
trask Sep 14, 2020
b44b886
feedback
trask Sep 15, 2020
db74266
Add note about otlp=otlp_span,otlp_metric
trask Sep 15, 2020
319d3cf
Merge remote-tracking branch 'upstream/master' into otel-exporter-env…
trask Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spec-compliance-matrix.md
View file
Open in desktop
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
View file
Open in desktop
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".
trask marked this conversation as resolved.
Show resolved Hide resolved

trask marked this conversation as resolved.
Show resolved Hide resolved
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