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 initial env var draft specification #666

Merged
merged 15 commits into from
Aug 5, 2020
Merged

add initial env var draft specification #666

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
151024f
add initial env var draft specification
mwear Jun 23, 2020
ad345fe
disable link checks for local endpoints
mwear Jun 24, 2020
cd162df
Fix typo
mwear Jun 24, 2020
5bfea8e
Add jaeger agent port
mwear Jun 24, 2020
9e80447
remove zipkin service name
mwear Jun 24, 2020
37d031d
add default column
mwear Jun 24, 2020
817cfdc
Remove Jaeger process tags
mwear Jun 29, 2020
5fd827b
Add note on language specific environment variables
mwear Jun 29, 2020
90ea3a7
Merge branch 'master' into env_var_spec
mwear Jul 18, 2020
fe3246c
align batch span processor naming with spec and add default values
mwear Jul 20, 2020
9ee6ce1
remove jaeger disabled configuration
mwear Jul 21, 2020
1a646a0
remove sampling probability configuration
mwear Jul 21, 2020
380121d
update timeout description for otlp span / metric export
mwear Jul 21, 2020
72d7268
reorganize columns, make notes last where applicable
mwear Jul 21, 2020
3f9095d
update note about OTEL_RESOURCE_LABELS
mwear Jul 21, 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
58 changes: 58 additions & 0 deletions specification/sdk-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# OpenTelemetry Environment Variable Specification

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.

## General SDK Configuration

| Name | Description | Default | Notes |
| -------------------- | ------------------------------------------------ | --------------------------------- | ------------------------------------------------------------------------------------------- |
| OTEL_RESOURCE_LABELS | Key-value pairs to be used as resource labels | | Spec details TBD. Proposal in [OTEP-111](https://github.com/open-telemetry/oteps/pull/111). |
| OTEL_LOG_LEVEL | Log level used by the SDK logger | "info" | |
| OTEL_PROPAGATORS | Propagators to be used as a comma separated list | "tracecontext,correlationcontext" | |

## Batch Span Processor

| Name | Description | Default | Notes |
| ------------------------------ | ---------------------------------------------- | ------- | ----------------------------------------------------- |
| OTEL_BSP_SCHEDULE_DELAY_MILLIS | Delay interval between two consecutive exports | 5000 | |
| OTEL_BSP_EXPORT_TIMEOUT_MILLIS | Maximum allowed time to export data | 30000 | |
| 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

| 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 | - |

## Jaeger Exporter

| Name | Description | Default |
| ------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| OTEL_EXPORTER_JAEGER_AGENT_HOST | Hostname for the Jaeger agent | "localhost" |
| OTEL_EXPORTER_JAEGER_AGENT_PORT | Port for the Jaeger agent | 6832 |
| OTEL_EXPORTER_JAEGER_ENDPOINT | HTTP endpoint for Jaeger traces | <!-- markdown-link-check-disable --> "http://localhost:14250"<!-- markdown-link-check-enable --> |
| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | - |
| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | - |

## Zipkin Exporter

| 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 --> |

## Language Specific Environment Variables

To ensure consistent naming across projects, this specification recommends that language specific environment variables are formed using the following convention:

```
OTEL_{LANGUAGE}_{FEATURE}
```