Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default OTLP/HTTP port number #3743

Conversation

tigrannajaryan
Copy link
Member

This implements specification change open-telemetry/opentelemetry-specification#1839

To make transition to new port numbers less painful OTLP receiver will
also accept data on the legacy port numbers when it is configured to
use the default endpoint. Users who use the default Collector config
can continue sending data to the legacy ports and have a graceful period
to update their senders to start sending to the new ports.

@tigrannajaryan
Copy link
Member Author

Should be merged after open-telemetry/opentelemetry-specification#1839 is merged.

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any documentation on what the grace period should be for both port to receive HTTP traffic?

@tigrannajaryan
Copy link
Member Author

Is there any documentation on what the grace period should be for both port to receive HTTP traffic?

There is none AFAIK. Suggestions are welcome. 6 months from now perhaps enough?

@tigrannajaryan tigrannajaryan marked this pull request as ready for review August 3, 2021 08:05
@tigrannajaryan tigrannajaryan requested review from a team and jpkrohling August 3, 2021 08:05
@tigrannajaryan
Copy link
Member Author

Spec PR is now merged open-telemetry/opentelemetry-specification#1839
This is ready for review.

jpkrohling
jpkrohling previously approved these changes Aug 3, 2021
@jpkrohling jpkrohling dismissed their stale review August 3, 2021 08:37

sorry, wanted to run a grep first

@jpkrohling
Copy link
Member

Looks like there are a few places missing:

$ grep 55681 . -r
./cmd/configschema/docsgen/docsgen/testdata/otlp-receiver.json:              "Default": "0.0.0.0:55681",
./exporter/otlphttpexporter/README.md:- `endpoint` (no default): The target base URL to send data to (e.g.: https://example.com:55681).
./exporter/otlphttpexporter/README.md:- `traces_endpoint` (no default): The target URL to send trace data to (e.g.: https://example.com:55681/v1/traces).
./exporter/otlphttpexporter/README.md:- `metrics_endpoint` (no default): The target URL to send metric data to (e.g.: https://example.com:55681/v1/metrics).
./exporter/otlphttpexporter/README.md:- `logs_endpoint` (no default): The target URL to send log data to (e.g.: https://example.com:55681/v1/logs).
./exporter/otlphttpexporter/README.md:    endpoint: https://example.com:55681/v1/traces
./receiver/otlpreceiver/config.md:| endpoint |string| 0.0.0.0:55681 | Endpoint configures the listening address for the server.  |
./receiver/otlpreceiver/factory.go:	legacyHTTPEndpoint  = "0.0.0.0:55681"
grep: ./bin/otelcol_linux_amd64: binary file matches
./website_docs/configuration.md:    endpoint: https://example.com:55681/v1/traces

@tigrannajaryan
Copy link
Member Author

Looks like there are a few places missing:

$ grep 55681 . -r
./cmd/configschema/docsgen/docsgen/testdata/otlp-receiver.json:              "Default": "0.0.0.0:55681",
./exporter/otlphttpexporter/README.md:- `endpoint` (no default): The target base URL to send data to (e.g.: https://example.com:55681).
./exporter/otlphttpexporter/README.md:- `traces_endpoint` (no default): The target URL to send trace data to (e.g.: https://example.com:55681/v1/traces).
./exporter/otlphttpexporter/README.md:- `metrics_endpoint` (no default): The target URL to send metric data to (e.g.: https://example.com:55681/v1/metrics).
./exporter/otlphttpexporter/README.md:- `logs_endpoint` (no default): The target URL to send log data to (e.g.: https://example.com:55681/v1/logs).
./exporter/otlphttpexporter/README.md:    endpoint: https://example.com:55681/v1/traces
./receiver/otlpreceiver/config.md:| endpoint |string| 0.0.0.0:55681 | Endpoint configures the listening address for the server.  |
./receiver/otlpreceiver/factory.go:	legacyHTTPEndpoint  = "0.0.0.0:55681"
grep: ./bin/otelcol_linux_amd64: binary file matches
./website_docs/configuration.md:    endpoint: https://example.com:55681/v1/traces

Thanks for the catch. I only greped *.go files :-(

This implements specification change open-telemetry/opentelemetry-specification#1839

To make transition to new port numbers less painful OTLP receiver will
also accept data on the legacy port numbers when it is configured to
use the default endpoint. Users who use the default Collector config
can continue sending data to the legacy ports and have a graceful period
to update their senders to start sending to the new ports.
@tigrannajaryan tigrannajaryan force-pushed the feature/tigran/otlp-http-port branch from 13ebcf5 to e1babcd Compare August 3, 2021 09:03
@tigrannajaryan
Copy link
Member Author

@jpkrohling PTAL, should be good now.

@theletterf
Copy link
Member

@tigrannajaryan Has anything been decided on the grace period?

@tigrannajaryan
Copy link
Member Author

@theletterf 6 months sounds reasonable to me. I think we should start the countdown from the moment Otel spec clearly documents the 4318 port, which we should do asap once the final decision to keep the ports separate is made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants