Use official OTLP types in api_v3 and avoid triple-marshaling #5098
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Test Results2 085 tests - 1 2 075 ✅ - 1 1m 8s ⏱️ -1s Results for commit a9bb33e. ± Comparison against base commit 09f7a30. This pull request removes 2 and adds 1 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5098 +/- ##
==========================================
+ Coverage 95.55% 95.61% +0.05%
==========================================
Files 319 320 +1
Lines 18379 18394 +15
==========================================
+ Hits 17562 17587 +25
+ Misses 655 649 -6
+ Partials 162 158 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
yurishkuro
added
the
changelog:breaking-change
yurishkuro
added a commit
to jaegertracing/jaeger-idl
that referenced
this pull request
Jan 14, 2024
yurishkuro
changed the title
yurishkuro
commented
Jan 14, 2024
| cp -R idl/opentelemetry-proto/* $(PATCHED_OTEL_PROTO_DIR) | ||
| find $(PATCHED_OTEL_PROTO_DIR) -name "*.proto" | xargs -L 1 $(SED) -i 's+go.opentelemetry.io/proto/otlp+github.com/jaegertracing/jaeger/proto-gen/otel+g' | ||
|
|
||
| $(call proto_compile, proto-gen/api_v3, idl/proto/api_v3/query_service.proto, -I$(PATCHED_OTEL_PROTO_DIR)) |
There was a problem hiding this comment.
- enriching is no longer needed
- types are generated into an internal module now
yurishkuro
commented
Jan 14, 2024
| @@ -180,9 +179,11 @@ func getServicesAPIV3(t *testing.T) { | |||
| require.NoError(t, err) | |||
| body, _ := io.ReadAll(resp.Body) | |||
|
|
|||
| var servicesResponse api_v3.GetServicesResponse | |||
There was a problem hiding this comment.
This was unnecessary coupling. api_v3 is not internal and not accessible from here.
yurishkuro
commented
Jan 14, 2024
| if err := proto.Unmarshal(b, &chunk); err != nil { | ||
| return nil, fmt.Errorf("cannot marshal OTLP: %w", err) | ||
| } | ||
| return chunk.ResourceSpans, nil |
There was a problem hiding this comment.
no triple marshaling!
Signed-off-by: Yuri Shkuro <github@ysh.us>
yurishkuro
changed the title
jkowall
approved these changes
Jan 15, 2024
yurishkuro
added a commit
that referenced
this pull request
Jan 16, 2024
## Description of the changes - Remove unused internal OTLP types, as a follow-up on #5098 - Marking it "breaking" to show up next to #5098 in the changelog, since technically these are exposed APIs from Jaeger-as-a-library ## How was this change tested? - CI Signed-off-by: Yuri Shkuro <github@ysh.us>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Description of the changes
SpansResponseChunkwith officialotlp.TracesData, but override it internally to use a custom typeHow was this change tested?