feat: rename batches property of Trace to ResourceSpans to be OTEL compatible #3895
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
javiermolinar
changed the title
javiermolinar
requested review from
joe-elliott,
annanay25,
mdisibio,
mapno,
kvrhdn,
zalegrala,
electron0zero,
ie-pham and
stoewer
as code owners
joe-elliott
approved these changes
Jul 25, 2024
| ) | ||
|
|
||
| // Marshal a Trace to an OTEL compatible JSON replacing resourceSpans by batches | ||
| func MarshalToJSONV1(t *Trace) ([]byte, error) { |
There was a problem hiding this comment.
it would be nice to get a short comment about why this method exists. how we renamed the batches field to resourceSpans and these utility methods are for (un)marshaling json from the v1 traces endpoint to the current proto object
There was a problem hiding this comment.
Sure, I can add more info
| @@ -18,3 +18,4 @@ | |||
| /tempodb/encoding/benchmark_block | |||
| private-key.key | |||
| integration/e2e/e2e_integration_test[0-9]* | |||
| .tempo.yaml | |||
There was a problem hiding this comment.
It is my local config to debug Tempo. I can leave it out
joe-elliott
approved these changes
Jul 25, 2024
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.
What this PR does:
Currently, the response from
/api/traces/when the the headerapplication/jsonis set is not OTEL compatible.The goal of this PR is to prepare the ground for a V2 traces API by making the response OTEL compatible without breaking the current behavior.
I have explored two approaches. The first one was creating a new TraceV2 proto message type. But that introduced a cascade of changes ending with cluttered code, adding even more complexity to the code base. With this approach, we keep the code as it is while being more descriptive by replacing the generic
Batcheswith a more specificResourceSpans.To make it retro-compatible, the response when the content-type header is
application/jsonremains the same:tempo/modules/frontend/combiner/trace_by_id.go
Line 125 in a66720a
Which issue(s) this PR fixes:
Fixes #3802
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]