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

[BREAKING CHANGE] Remove deprecated Jaeger tchannel receiver #636

Merged
merged 4 commits into from Mar 31, 2020

Conversation

objectiser
Copy link
Contributor

Description:
Remove the deprecated tchannel support from the Jaeger receiver.

Link to tracking Issue:
Resolves #267

Testing:
Relevant tests were removed.

Documentation:
Removed references to tchannel from the documentation.

@@ -158,14 +153,6 @@ func (f *Factory) CreateTraceReceiver(
}
}

if protoTChannel != nil && protoTChannel.IsEnabled() {
Copy link
Member

Choose a reason for hiding this comment

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

What happens if someone has this in the config file? Would it silently be ignored? Perhaps there could be a warning stating that this has been removed and that gRPC should be used instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It would currently complain - so fail fast. It is the same issue with the jaeger thrift exporter being removed, and the existing one renamed from jaeger_grpc to jaeger.

As there is already going to be a breaking change for the next release, my preference would be to just get this one removed as well - so cleaned up before getting to 1.x.

Copy link
Contributor

Choose a reason for hiding this comment

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

related nit: could you ensure that the message says something like unknown or not supported just to be clear that it may be a known protocol but not supported (no need to distinguish what is the exact case).

cfg := factory.CreateDefaultConfig()
rCfg := cfg.(*Config)

rCfg.Protocols[protoThriftTChannel], _ = defaultsForProtocol(protoThriftTChannel)
Copy link
Member

Choose a reason for hiding this comment

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

One of the tests should be kept, describing what happens when this old option is being used.

Copy link
Contributor

Choose a reason for hiding this comment

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

There is already a test for unknown protocols this should include a test implicit against the one being removed.

@objectiser objectiser changed the title Remove deprecated Jaeger tchannel receiver [BREAKING CHANGE] Remove deprecated Jaeger tchannel receiver Mar 16, 2020
Copy link
Contributor

@pjanotti pjanotti left a comment

Choose a reason for hiding this comment

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

Minor suggestions only @objectiser. Requesting changes to hold it off until we have the same receiver on Contrib. Unfortunately, in this case, it will need a different name in the config. Perhaps jaeger_legacy on contrib repo? My thought is that we can deprecate more Jaeger protocols later.

go.mod Outdated Show resolved Hide resolved
@@ -158,14 +153,6 @@ func (f *Factory) CreateTraceReceiver(
}
}

if protoTChannel != nil && protoTChannel.IsEnabled() {
Copy link
Contributor

Choose a reason for hiding this comment

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

related nit: could you ensure that the message says something like unknown or not supported just to be clear that it may be a known protocol but not supported (no need to distinguish what is the exact case).

go.sum Show resolved Hide resolved
cfg := factory.CreateDefaultConfig()
rCfg := cfg.(*Config)

rCfg.Protocols[protoThriftTChannel], _ = defaultsForProtocol(protoThriftTChannel)
Copy link
Contributor

Choose a reason for hiding this comment

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

There is already a test for unknown protocols this should include a test implicit against the one being removed.

testbed/go.sum Outdated Show resolved Hide resolved
@pjanotti
Copy link
Contributor

Requesting changes to hold it off until we have the same receiver on Contrib

@objectiser I think it will be easier if I tag a version of core repo now so you can then move the code as it is (minus protocols on core) to contrib.

@codecov-io
Copy link

Codecov Report

Merging #636 into master will increase coverage by 1.51%.
The diff coverage is 80%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #636      +/-   ##
==========================================
+ Coverage   74.47%   75.98%   +1.51%     
==========================================
  Files         145      145              
  Lines       10161    10613     +452     
==========================================
+ Hits         7567     8064     +497     
+ Misses       2228     2167      -61     
- Partials      366      382      +16
Impacted Files Coverage Δ
receiver/jaegerreceiver/trace_receiver.go 82.72% <100%> (-3.05%) ⬇️
receiver/jaegerreceiver/factory.go 96.61% <66.66%> (-1.78%) ⬇️
internal/data/common.go 84% <0%> (-16%) ⬇️
obsreport/obsreport.go 79.16% <0%> (-4.77%) ⬇️
exporter/loggingexporter/logging_exporter.go 78.26% <0%> (-3.67%) ⬇️
internal/data/trace.go 34.46% <0%> (-0.48%) ⬇️
config/config.go 99.23% <0%> (-0.01%) ⬇️
receiver/factory.go 100% <0%> (ø) ⬆️
processor/metrics.go 0% <0%> (ø) ⬆️
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5f9704c...dab30a6. Read the comment docs.

@pjanotti
Copy link
Contributor

@objectiser contrib was updated, the receiver can be moved to contrib without, or with very minimal, changes.

@objectiser
Copy link
Contributor Author

@pjanotti Thanks, I'll try to get that done in the next couple of days.

@objectiser
Copy link
Contributor Author

@pjanotti @owais This one should be ready to review/merge.

Copy link
Contributor

@pjanotti pjanotti left a comment

Choose a reason for hiding this comment

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

LGTM

@pjanotti pjanotti merged commit d883f9b into open-telemetry:master Mar 31, 2020
@objectiser objectiser deleted the tchannel branch March 31, 2020 22:01
tigrannajaryan pushed a commit that referenced this pull request Jun 26, 2020
Support was removed in #636 and the error will still be returned because we return an error for every unknown protocol.
wyTrivail pushed a commit to mxiamxia/opentelemetry-collector that referenced this pull request Jul 13, 2020
Support was removed in open-telemetry#636 and the error will still be returned because we return an error for every unknown protocol.
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.

Remove TChannel support from Jaeger Receiver
5 participants