Skip to content

Commit

Permalink
More explanation for OTLP transport protocols (#1790)
Browse files Browse the repository at this point in the history
  • Loading branch information
iNikem authored Jul 12, 2021
1 parent 52cc128 commit 862a1a3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ release.

### OpenTelemetry Protocol

- Adding requirement to implement at least one of two transports: `grpc` or `http/protobuf`.
([#1790](https://github.com/open-telemetry/opentelemetry-specification/pull/1790/files))

### SDK Configuration

## v1.5.0 (2021-07-08)
Expand Down
2 changes: 1 addition & 1 deletion spec-compliance-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Note: Support for environment variables is optional.
| [OTLP](specification/protocol/otlp.md) | | | | | | | | | | | | |
| OTLP/gRPC Exporter | * | + | + | + | + | | + | | + | + | + | + |
| OTLP/HTTP binary Protobuf Exporter | * | + | - | + | [-][py1106] | + | + | | | - | - | - |
| OTLP/HTTP JSON Protobuf Exporter | * | + | - | + | [-][py1003] | | - | | | - | - | - |
| OTLP/HTTP JSON Protobuf Exporter | | + | - | + | [-][py1003] | | - | | | - | - | - |
| OTLP/HTTP gzip Content-Encoding support | X | + | - | + | + | + | - | | | - | - | - |
| Concurrent sending | | - | + | + | [-][py1108] | | - | | + | - | - | - |
| Honors retryable responses with backoff | X | + | | + | + | + | - | | | - | - | - |
Expand Down
12 changes: 9 additions & 3 deletions specification/protocol/exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=https://collector.example.com/v1/metr

### Specify Protocol

Currently, OTLP has more than one transport protocol it can support, e.g.
`grpc`, `http/json`, `http/protobuf`. As of 1.0 of the specification, there
*is no specified default, or configuration via environment variables*. We
Currently, OTLP supports the following transport protocols:

- `grpc` for protobuf-encoded data using gRPC wire format over HTTP/2 connection
- `http/protobuf` for protobuf-encoded data over HTTP connection
- `http/json` for JSON-encoded data over HTTP connection

SDKs MUST support either `grpc` or `http/protobuf` and SHOULD support both. They also MAY support `http/json`.

As of 1.0 of the specification, there *is no specified default, or configuration via environment variables*. We
reserve the following environment variables for configuration of protocols in
the future:

Expand Down

0 comments on commit 862a1a3

Please sign in to comment.