Skip to content

Commit 7149d19

Browse files
Correct description of OTEL_EXPORTER_JAEGER_ENDPOINT and OTEL_TRACES_EXPORTER (open-telemetry#2333)
* Change description/default of OTEL_EXPORTER_JAEGER_ENDPOINT to point to correct HTTP port Signed-off-by: Yuri Shkuro <github@ysh.us> * url Signed-off-by: Yuri Shkuro <github@ysh.us> * fix Signed-off-by: Yuri Shkuro <github@ysh.us> * footnotes Signed-off-by: Yuri Shkuro <github@ysh.us> * cr Signed-off-by: Yuri Shkuro <github@ysh.us> * fix Signed-off-by: Yuri Shkuro <github@ysh.us> * fix Signed-off-by: Yuri Shkuro <github@ysh.us> * fix Signed-off-by: Yuri Shkuro <github@ysh.us> Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
1 parent 86ebbef commit 7149d19

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ release.
1717
- Add support for probability sampling in the OpenTelemetry `tracestate` entry and
1818
add optional specification for consistent probability sampling.
1919
([#2047](https://github.com/open-telemetry/opentelemetry-specification/pull/2047))
20+
- Change description and default value of OTEL_EXPORTER_JAEGER_ENDPOINT env var
21+
to point to the correct HTTP port and correct description of OTEL_TRACES_EXPORTER
22+
([#2333](https://github.com/open-telemetry/opentelemetry-specification/pull/2333)).
2023

2124
### Metrics
2225

specification/sdk-environment-variables.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,16 @@ See [OpenTelemetry Protocol Exporter Configuration Options](./protocol/exporter.
126126

127127
| Name | Description | Default |
128128
|---------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
129-
| OTEL_EXPORTER_JAEGER_AGENT_HOST | Hostname for the Jaeger agent | "localhost" |
129+
| OTEL_EXPORTER_JAEGER_AGENT_HOST | Hostname for the Jaeger agent [1] | "localhost" |
130130
| OTEL_EXPORTER_JAEGER_AGENT_PORT | Port for the Jaeger agent `compact` Thrift protocol | 6831 |
131-
| OTEL_EXPORTER_JAEGER_ENDPOINT | HTTP endpoint for Jaeger traces | <!-- markdown-link-check-disable --> "http://localhost:14250"<!-- markdown-link-check-enable --> |
131+
| OTEL_EXPORTER_JAEGER_ENDPOINT | Full URL of [Thrift over HTTP][jaeger_http] endpoint for Jaeger traces [2] | <!-- markdown-link-check-disable --> `"http://localhost:14268/api/traces"` <!-- markdown-link-check-enable --> |
132132
| OTEL_EXPORTER_JAEGER_TIMEOUT | Maximum time the Jaeger exporter will wait for each batch export | 10s |
133133
| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | |
134134
| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | |
135135

136-
See [Jaeger Agent](https://www.jaegertracing.io/docs/latest/deployment/#agent) documentation.
136+
[1] See [Jaeger Agent](https://www.jaegertracing.io/docs/latest/deployment/#agent) documentation.
137+
138+
[2] When the exporter uses the gRPC protocol, the environment variable refers to the gRPC endpoint and the default value should be `http://localhost:14250`.
137139

138140
## Zipkin Exporter
139141

@@ -179,7 +181,11 @@ The SDK MAY accept a comma-separated list to enable setting multiple exporters.
179181
Known values for `OTEL_TRACES_EXPORTER` are:
180182

181183
- `"otlp"`: [OTLP](./protocol/otlp.md)
182-
- `"jaeger"`: [Jaeger gRPC](https://www.jaegertracing.io/docs/1.21/apis/#protobuf-via-grpc-stable)
184+
- `"jaeger"`: export in Jaeger data model. If no additional configuration is
185+
provided the default protocol SHOULD be [Thrift over HTTP][jaeger_http] unless
186+
SDKs have good reasons to choose [gRPC][jaeger_grpc] as the default
187+
(e.g. for backward compatibility reasons when gRPC was already the default
188+
in a stable SDK release).
183189
- `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) (Defaults to [protobuf](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto) format)
184190
- `"none"`: No automatically configured exporter for traces.
185191

@@ -222,3 +228,6 @@ To ensure consistent naming across projects, this specification recommends that
222228
```
223229
OTEL_{LANGUAGE}_{FEATURE}
224230
```
231+
232+
[jaeger_http]: https://www.jaegertracing.io/docs/latest/apis/#thrift-over-http-stable
233+
[jaeger_grpc]: https://www.jaegertracing.io/docs/latest/apis/#protobuf-via-grpc-stable

0 commit comments

Comments
 (0)