[ES] Refactor `FindTraces` and `GetTrace` of SpanReader to make them reusable for v2 APIs by Manik2708 · Pull Request #6845 · jaegertracing/jaeger

Manik2708 · 2025-03-12T19:11:35Z

Which problem is this PR solving?

Fixes a part of: #6458

Description of the changes

Refactoring of FindTraces and GetTrace to complete refactoring for ES Span Reader

How was this change tested?

Unit tests

Checklist

I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
I have signed all commits
I have added unit tests for the new functionality
I have run lint and test steps successfully
- for jaeger: make lint test
- for jaeger-ui: npm run lint and npm run test

Manik2708 · 2025-03-12T19:19:28Z

Fixing tests!

codecov · 2025-03-12T19:20:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.05%. Comparing base (2be68dc) to head (76f3892).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6845      +/-   ##
==========================================
- Coverage   96.05%   96.05%   -0.01%     
==========================================
  Files         367      368       +1     
  Lines       20831    20844      +13     
==========================================
+ Hits        20010    20021      +11     
- Misses        626      628       +2     
  Partials      195      195

Flag	Coverage Δ
badger_v1	`9.87% <0.00%> (-0.02%)`	⬇️
badger_v2	`2.05% <0.00%> (-0.01%)`	⬇️
cassandra-4.x-v1-manual	`14.85% <0.00%> (-0.02%)`	⬇️
cassandra-4.x-v2-auto	`2.04% <0.00%> (-0.01%)`	⬇️
cassandra-4.x-v2-manual	`2.04% <0.00%> (-0.01%)`	⬇️
cassandra-5.x-v1-manual	`14.85% <0.00%> (-0.02%)`	⬇️
cassandra-5.x-v2-auto	`2.04% <0.00%> (-0.01%)`	⬇️
cassandra-5.x-v2-manual	`2.04% <0.00%> (-0.01%)`	⬇️
elasticsearch-6.x-v1	`19.49% <74.62%> (-0.06%)`	⬇️
elasticsearch-7.x-v1	`19.57% <74.62%> (-0.06%)`	⬇️
elasticsearch-8.x-v1	`19.74% <74.62%> (-0.06%)`	⬇️
elasticsearch-8.x-v2	`2.05% <0.00%> (-0.01%)`	⬇️
grpc_v1	`10.90% <0.00%> (-0.02%)`	⬇️
grpc_v2	`7.97% <0.00%> (-0.02%)`	⬇️
kafka-3.x-v1	`10.16% <0.00%> (-0.02%)`	⬇️
kafka-3.x-v2	`2.05% <0.00%> (-0.01%)`	⬇️
memory_v2	`2.05% <0.00%> (-0.01%)`	⬇️
opensearch-1.x-v1	`19.62% <74.62%> (-0.06%)`	⬇️
opensearch-2.x-v1	`19.62% <74.62%> (-0.06%)`	⬇️
opensearch-2.x-v2	`2.05% <0.00%> (-0.01%)`	⬇️
tailsampling-processor	`0.55% <0.00%> (-0.01%)`	⬇️
unittests	`94.90% <97.01%> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

internal/storage/v1/elasticsearch/spanstore/internal/dbmodel/model.go

## Which problem is this PR solving? Fixes a part of #6458 ## Description of the changes - As discussed in the comment #6845 (comment), legacy trace id is moved to feature gate ## How was this change tested? - Unit and Integration tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

internal/storage/v1/elasticsearch/spanstore/reader.go

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

internal/storage/v1/elasticsearch/spanstore/reader.go

internal/storage/v1/elasticsearch/spanstore/readerv1.go

internal/storage/v1/elasticsearch/spanstore/readerv1_test.go

internal/storage/v1/elasticsearch/spanstore/reader_test.go

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

internal/storage/v1/elasticsearch/spanstore/reader.go

internal/storage/v1/elasticsearch/spanstore/reader_test.go

yurishkuro · 2025-03-17T22:47:00Z

internal/storage/v1/elasticsearch/spanstore/reader_test.go

 		{
 			traceID:                 traceIDHigh,
 			query:                   elastic.NewTermQuery(traceIDField, "00000000000000010000000000000001"),
 			disableLegacyIdsEnabled: true,


this same test with false should produce two queries, one of them for 10000000000000001

It's already there, please see the second test

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

internal/storage/v1/elasticsearch/spanstore/reader.go

yurishkuro · 2025-03-18T14:59:45Z

internal/storage/v1/elasticsearch/spanstore/internal/dbmodel/model.go


+// Trace is the type of traces
+type Trace struct {
+	Spans []*Span


can we do without pointer?

Suggested change

Spans []*Span

Spans []Span

Even I wanted to do that but then I was concerned that it might increase the diff, as all the methods in core reader are returing pointers. Should I do that refactoring in this PR? Or a separate PR after this?

yurishkuro · 2025-03-18T15:00:21Z

internal/storage/v1/elasticsearch/spanstore/core_span_reader.go

-	// GetTrace takes a traceID and returns a Trace associated with that traceID
-	GetTrace(ctx context.Context, query spanstore.GetTraceParameters) (*model.Trace, error)
+	// GetTraces takes a traceID and returns a Trace associated with that traceID
+	GetTraces(ctx context.Context, query []dbmodel.TraceID) ([]*dbmodel.Trace, error)


in the next PR can we try to get rid of all the pointers in the signatures? They are not providing any value, only forcing extra memory allocations.

internal/storage/v1/elasticsearch/spanstore/readerv1_test.go

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

…reusable for v2 APIs (jaegertracing#6845) ## Which problem is this PR solving? Fixes a part of: jaegertracing#6458 ## Description of the changes - Refactoring of `FindTraces` and `GetTrace` to complete refactoring for ES Span Reader ## How was this change tested? - Unit tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com> Signed-off-by: sAchin-680 <mrmister680@gmail.com>

…gertracing#6848) ## Which problem is this PR solving? Fixes a part of jaegertracing#6458 ## Description of the changes - As discussed in the comment jaegertracing#6845 (comment), legacy trace id is moved to feature gate ## How was this change tested? - Unit and Integration tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

…reusable for v2 APIs (jaegertracing#6845) ## Which problem is this PR solving? Fixes a part of: jaegertracing#6458 ## Description of the changes - Refactoring of `FindTraces` and `GetTrace` to complete refactoring for ES Span Reader ## How was this change tested? - Unit tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

…gertracing#6848) ## Which problem is this PR solving? Fixes a part of jaegertracing#6458 ## Description of the changes - As discussed in the comment jaegertracing#6845 (comment), legacy trace id is moved to feature gate ## How was this change tested? - Unit and Integration tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com> Signed-off-by: amol-verma-allen <amol.verma@allen.in>

…reusable for v2 APIs (jaegertracing#6845) ## Which problem is this PR solving? Fixes a part of: jaegertracing#6458 ## Description of the changes - Refactoring of `FindTraces` and `GetTrace` to complete refactoring for ES Span Reader ## How was this change tested? - Unit tests ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `npm run lint` and `npm run test` --------- Signed-off-by: Manik2708 <mehtamanik96@gmail.com> Signed-off-by: amol-verma-allen <amol.verma@allen.in>

Manik2708 requested a review from a team as a code owner March 12, 2025 19:11

Manik2708 requested a review from mahadzaryab1 March 12, 2025 19:11

dosubot bot added storage/elasticsearch v2 labels Mar 12, 2025

yurishkuro reviewed Mar 12, 2025

View reviewed changes

internal/storage/v1/elasticsearch/spanstore/internal/dbmodel/model.go Outdated Show resolved Hide resolved

Manik2708 mentioned this pull request Mar 13, 2025

[ES] Add feature to stop Legacy Trace IDs handling in SpanReader #6848

Merged

4 tasks

cleanup

4d7ae4a

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

Manik2708 force-pushed the es-reader branch from 579212e to 4d7ae4a Compare March 15, 2025 13:38

Manik2708 commented Mar 15, 2025

View reviewed changes

internal/storage/v1/elasticsearch/spanstore/reader.go Outdated Show resolved Hide resolved

Manik2708 requested a review from yurishkuro March 15, 2025 13:41

Manik2708 added 2 commits March 15, 2025 19:19

cleanup

37567dd

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

dependency manage

4c83738

Signed-off-by: Manik2708 <mehtamanik96@gmail.com>

Manik2708 commented Mar 15, 2025

View reviewed changes

internal/storage/v1/elasticsearch/spanstore/reader.go Outdated Show resolved Hide resolved