Skip to content

Commit

Permalink
Document OTLP endpoints better
Browse files Browse the repository at this point in the history
Signed-off-by: Yuri Shkuro <github@ysh.us>
  • Loading branch information
yurishkuro committed Nov 17, 2023
1 parent 7dbb843 commit b25eda4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
9 changes: 7 additions & 2 deletions content/docs/next-release/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ Since Jaeger v1.32, **jaeger-collector** and **jaeger-query** Service ports that

Since v1.35, the Jaeger backend can receive trace data from the OpenTelemetry SDKs in their native [OpenTelemetry Protocol (OTLP)][otlp]. It is no longer necessary to configure the OpenTelemetry SDKs with Jaeger exporters, nor deploy the OpenTelemetry Collector between the OpenTelemetry SDKs and the Jaeger backend.

The OTLP data is accepted in these formats: (1) binary gRPC, (2) Protobuf over HTTP, (3) JSON over HTTP. For more details on the OTLP receiver see the [official documentation][otlp-rcvr] (note that not all configuration options are supported in **jaeger-collector**, and only tracing data is accepted, since Jaeger does not store other telemetry types).
The OTLP data is accepted in these formats: (1) binary gRPC, (2) Protobuf over HTTP, (3) JSON over HTTP. For more details on the OTLP receiver see the [official documentation][otlp-rcvr]. Note that not all configuration options are supported in **jaeger-collector** (see `--collector.otlp.*` [CLI Flags](../cli/#jaeger-collector)), and only tracing data is accepted, since Jaeger does not store other telemetry types.

| Port | Protocol | Endpoint | Format
| ----- | ------- | ------------ | ----
| 4317 | gRPC | n/a | Protobuf
| 4318 | HTTP | `/v1/traces` | Protobuf or JSON

[otlp-rcvr]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/otlpreceiver/README.md
[otlp]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md

### Thrift over UDP (stable)

Expand Down Expand Up @@ -135,5 +141,4 @@ Please refer to the [SPM Documentation](../spm#api)
[sampling.proto]: https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto
[grpc-reflection]: https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md#enable-server-reflection
[gogo-reflection]: https://jbrandhorst.com/post/gogoproto/#reflection
[otlp]: https://opentelemetry.io/docs/reference/specification/protocol/
[storage.proto]: https://github.com/jaegertracing/jaeger/blob/main/plugin/storage/grpc/proto/storage.proto
20 changes: 12 additions & 8 deletions content/docs/next-release/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,14 +162,16 @@ command line options.

At default settings **jaeger-collector** exposes the following ports:

Port | Protocol | Function
----- | ------- | ---
9411 | HTTP | Accepts Zipkin spans in Thrift, JSON and Proto (disabled by default).
14250 | gRPC | Used by **jaeger-agent** to send spans in model.proto format.
14268 | HTTP | Accepts spans directly from clients in [jaeger.thrift][jaeger-thrift] format with `binary` thrift protocol (`POST` to `/api/traces`). Also serves sampling policies at `/api/sampling` (see [Remote Sampling](../sampling/#remote-sampling)).
14269 | HTTP | Admin port: health check at `/` and metrics at `/metrics`.
4317 | gRPC | Accepts traces in OpenTelemetry OTLP format if `--collector.otlp.enabled=true`.
4318 | HTTP | Accepts traces in OpenTelemetry OTLP format if `--collector.otlp.enabled=true`.
| Port | Protocol | Endpoint | Function
| ----- | ------- | -------- | ----
| 4317 | gRPC | n/a | Accepts traces in [OpenTelemetry OTLP format][otlp] (Protobuf).
| 4318 | HTTP | `/v1/traces` | Accepts traces in [OpenTelemetry OTLP format][otlp] (Protobuf and JSON).
| 14268 | HTTP | `/api/sampling` | Serves sampling policies (see [Remote Sampling](../sampling/#remote-sampling)).
| | | `/api/traces` | Accepts spans in [jaeger.thrift][jaeger-thrift] format with `binary` thrift protocol (`POST`).
| 14269 | HTTP | `/` | Admin port: health check (`GET`).
| | | `/metrics` | Prometheus-style metrics (`GET`).
| 9411 | HTTP | `/api/v1/spans` and `/api/v2/spans` | Accepts Zipkin spans in Thrift, JSON and Proto (disabled by default).
| 14250 | gRPC | n/a | Used by **jaeger-agent** to send spans in [model.proto][] Protobuf format.

## Ingester

Expand Down Expand Up @@ -834,5 +836,7 @@ Production deployments need an external process which aggregates data and create
[cqlsh]: http://cassandra.apache.org/doc/latest/tools/cqlsh.html
[zipkin-thrift]: https://github.com/jaegertracing/jaeger-idl/blob/master/thrift/zipkincore.thrift
[jaeger-thrift]: https://github.com/jaegertracing/jaeger-idl/blob/master/thrift/jaeger.thrift
[model.proto]: https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/model.proto
[thriftrw]: https://www.npmjs.com/package/thriftrw
[storage.proto]: https://github.com/jaegertracing/jaeger/blob/main/plugin/storage/grpc/proto/storage.proto
[otlp]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md

0 comments on commit b25eda4

Please sign in to comment.