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

feat(otlp-exporter-http): change otlp-http port to canonical 4318 #2557

Merged
merged 7 commits into from Jan 20, 2022

Conversation

secustor
Copy link
Contributor

Signed-off-by: secustor sebastian@poxhofer.at

Which problem is this PR solving?

Used default port is not the one described in the specification for opentelemetry-exporter-otlp-http

Reference: https://github.com/open-telemetry/opentelemetry-specification/blob/401bb9c944323d5e3fc773b88ad3319c01abcff0/specification/protocol/exporter.md

Short description of the changes

This PR modifies the default port of the experimental opentelemetry-exporter-otlp-http exporter from 55681 to the canonical 4318

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

I have run the test cases using npm test

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

Signed-off-by: secustor <sebastian@poxhofer.at>
@secustor secustor requested a review from a team as a code owner October 21, 2021 15:29
@rauno56
Copy link
Member

rauno56 commented Oct 21, 2021

Related: #2395

As I understand from the discussions in ☝️, spec intended to stabilize 4317 for the port for OTLP in general? Has it changed?

@secustor
Copy link
Contributor Author

secustor commented Oct 21, 2021

I have gone initially simply from the current specification, but it seems there has been some discussion.

Speaking from this commit open-telemetry/opentelemetry-specification@90d9aab it seems to be settled on this setup tough.

Copy link
Member

@rauno56 rauno56 left a comment

Choose a reason for hiding this comment

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

IANA is still yet to approve the port reservation.

Although it is in fact following the current spec, I wouldn't rush merging it just yet.

@codecov
Copy link

codecov bot commented Oct 26, 2021

Codecov Report

Merging #2557 (df83311) into main (8bda25c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2557   +/-   ##
=======================================
  Coverage   93.22%   93.22%           
=======================================
  Files         157      157           
  Lines        5432     5432           
  Branches     1141     1141           
=======================================
  Hits         5064     5064           
  Misses        368      368           

@vmarchaud vmarchaud added the enhancement New feature or request label Oct 26, 2021
@vmarchaud
Copy link
Member

We definively had some trouble in the past with the back and forth to use one port for both http and grpc so i would like to wait to have a definitive spec to follow before merging this (i guess after IANA will approve the port)

@github-actions
Copy link

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale label Dec 27, 2021
@dyladan
Copy link
Member

dyladan commented Dec 27, 2021

This PR has many conflicts, but the new collector has probably been out long enough to use the new default port

@dyladan
Copy link
Member

dyladan commented Dec 28, 2021

According to https://github.com/open-telemetry/opentelemetry-specification/pull/1970/files it looks like the default should also be https?

@secustor
Copy link
Contributor Author

Not sure if it is wise to change this, as this could break setups. It is probably the best to wait till a x.0.0 release and change it then.

@github-actions github-actions bot removed the stale label Jan 3, 2022
@dyladan
Copy link
Member

dyladan commented Jan 5, 2022

According to open-telemetry/opentelemetry-specification#1970 (files) it looks like the default should also be https?

doh!

I agree we can't really change it now but it is unfortunate.

@dyladan
Copy link
Member

dyladan commented Jan 6, 2022

According to open-telemetry/opentelemetry-specification#1970 (files) it looks like the default should also be https?

doh!

I agree we can't really change it now but it is unfortunate.

Actually because we haven't released the exporter yet as 1.x we can change it. I think we should try to follow spec as closely as possible which would mean using http://localhost:4318 as the default for HTTP and http://localhost:4317 for gRPC. Looks like the default was changed from https to http about 3 months ago: open-telemetry/opentelemetry-specification#2014

I do question why use http:// for gRPC instead of grpc:// but that might just be a minor spec inconsistency that we can ignore for now safely.

@dyladan
Copy link
Member

dyladan commented Jan 19, 2022

@secustor can you address @blumamir's comments so we can merge this PR? We want to release the 1.0 of the package and this change is one we want in before we can release.

@secustor
Copy link
Contributor Author

I have updated all components of those two example to the newest versions and fixed the breaking changes

@dyladan dyladan merged commit e32879a into open-telemetry:main Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants