Skip to content

Commit 19c839a

Browse files
Change default OTLP port number (open-telemetry#1221)
* 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
1 parent ba0bab3 commit 19c839a

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ New:
1111

1212
- Document service name mapping for Jaeger exporters
1313
([1222](https://github.com/open-telemetry/opentelemetry-specification/pull/1222))
14+
- Change default OTLP port number
15+
([#1221](https://github.com/open-telemetry/opentelemetry-specification/pull/1221))
1416
- Add performance benchmark specification
1517
([#748](https://github.com/open-telemetry/opentelemetry-specification/pull/748))
1618
- Enforce that the Baggage API must be fully functional, even without an installed SDK.

specification/protocol/exporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The following configuration options MUST be available to configure the OTLP expo
88

99
| Configuration Option | Description | Default | Env variable |
1010
| -------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ |
11-
| 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` |
11+
| 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` |
1212
| 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` |
1313
| 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` |
1414
| 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` |
@@ -26,7 +26,7 @@ Example 1
2626
The following configuration sends all signals to the same collector:
2727

2828
```bash
29-
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:55680
29+
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317
3030
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
3131
```
3232

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

3737
```bash
38-
export OTEL_EXPORTER_OTLP_SPAN_ENDPOINT=collector:55680
38+
export OTEL_EXPORTER_OTLP_SPAN_ENDPOINT=collector:4317
3939
export OTEL_EXPORTER_OTLP_SPAN_PROTOCOL=grpc
4040
export OTEL_EXPORTER_OTLP_SPAN_INSECURE=true
4141

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

5050
```bash
51-
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:55680
51+
export OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317
5252
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
5353

5454
export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=collector.example.com/v1/metrics

specification/protocol/otlp.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ some in beta.
289289

290290
#### Default Port
291291

292-
The default network port for OTLP/gRPC is 55680.
292+
The default network port for OTLP/gRPC is 4317.
293293

294294
### OTLP/HTTP
295295

@@ -445,10 +445,7 @@ connections SHOULD be configurable.
445445

446446
#### Default Port
447447

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

453450
## Implementation Recommendations
454451

0 commit comments

Comments
 (0)