Skip to content

Commit

Permalink
Change default OTLP port number (open-telemetry#1221)
Browse files Browse the repository at this point in the history
* Change default OTLP port number

Contributes to open-telemetry#1148

Note that a separate port is used for OTLP/HTTP for now. There is currently work
in progress to confirm that we can use the same port. Once we have the confirmation
I will update the spec again to use one port.

* Address PR comments
  • Loading branch information
tigrannajaryan authored Nov 16, 2020
1 parent ba0bab3 commit 19c839a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ New:

- Document service name mapping for Jaeger exporters
([1222](https://github.com/open-telemetry/opentelemetry-specification/pull/1222))
- Change default OTLP port number
([#1221](https://github.com/open-telemetry/opentelemetry-specification/pull/1221))
- Add performance benchmark specification
([#748](https://github.com/open-telemetry/opentelemetry-specification/pull/748))
- Enforce that the Baggage API must be fully functional, even without an installed SDK.
Expand Down
8 changes: 4 additions & 4 deletions specification/protocol/exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following configuration options MUST be available to configure the OTLP expo

| Configuration Option | Description | Default | Env variable |
| -------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ |
| Endpoint | Target to which the exporter is going to send spans or metrics. This MAY be configured to include a path (e.g. `example.com/v1/traces`). | `localhost:55680` | `OTEL_EXPORTER_OTLP_ENDPOINT` `OTEL_EXPORTER_OTLP_SPAN_ENDPOINT` `OTEL_EXPORTER_OTLP_METRIC_ENDPOINT` |
| Endpoint | Target to which the exporter is going to send spans or metrics. This MAY be configured to include a path (e.g. `example.com/v1/traces`). | `localhost:4317` | `OTEL_EXPORTER_OTLP_ENDPOINT` `OTEL_EXPORTER_OTLP_SPAN_ENDPOINT` `OTEL_EXPORTER_OTLP_METRIC_ENDPOINT` |
| Protocol | The protocol used to transmit the data. One of `grpc`,`http/json`,`http/protobuf`. | `grpc` | `OTEL_EXPORTER_OTLP_PROTOCOL` `OTEL_EXPORTER_OTLP_SPAN_PROTOCOL` `OTEL_EXPORTER_OTLP_METRIC_PROTOCOL` |
| Insecure | Whether to enable client transport security for the exporter's `grpc` or `http` connection. | `false` | `OTEL_EXPORTER_OTLP_INSECURE` `OTEL_EXPORTER_OTLP_SPAN_INSECURE` `OTEL_EXPORTER_OTLP_METRIC_INSECURE` |
| Certificate File | Path to certificate file for TLS credentials of gRPC client. Should only be used if `insecure` is set to `false`. | n/a | `OTEL_EXPORTER_OTLP_CERTIFICATE` `OTEL_EXPORTER_OTLP_SPAN_CERTIFICATE` `OTEL_EXPORTER_OTLP_METRIC_CERTIFICATE` |
Expand All @@ -26,7 +26,7 @@ Example 1
The following configuration sends all signals to the same collector:

```bash
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:55680
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
```

Expand All @@ -35,7 +35,7 @@ Example 2
Traces and metrics are sent to different collectors using different protocols:

```bash
export OTEL_EXPORTER_OTLP_SPAN_ENDPOINT=collector:55680
export OTEL_EXPORTER_OTLP_SPAN_ENDPOINT=collector:4317
export OTEL_EXPORTER_OTLP_SPAN_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_SPAN_INSECURE=true

Expand All @@ -48,7 +48,7 @@ Example 3
Traces are configured using the generic configuration, metrics are configured using specific configuration:

```bash
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:55680
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc

export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=collector.example.com/v1/metrics
Expand Down
7 changes: 2 additions & 5 deletions specification/protocol/otlp.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ some in beta.

#### Default Port

The default network port for OTLP/gRPC is 55680.
The default network port for OTLP/gRPC is 4317.

### OTLP/HTTP

Expand Down Expand Up @@ -445,10 +445,7 @@ connections SHOULD be configurable.

#### Default Port

The default network port for OTLP/HTTP is 55681. There is currently an [open
issue](https://github.com/open-telemetry/opentelemetry-collector/issues/1256) to
use the same port for OTLP/gRPC and OTLP/HTTP. In that case this spec will be
updated to use the same default port for OTLP/gRPC and OTLP/HTTP.
The default network port for OTLP/HTTP is 4317.

## Implementation Recommendations

Expand Down

0 comments on commit 19c839a

Please sign in to comment.