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

[refactor] Remove archive reader and writer from remote storage grpc handler #6611

Merged
merged 6 commits into from
Jan 26, 2025

Conversation

mahadzaryab1
Copy link
Collaborator

@mahadzaryab1 mahadzaryab1 commented Jan 26, 2025

Which problem is this PR solving?

Description of the changes

  • 🛑 This PR deprecates two fields in the CapabilitiesResponse; ArchiveSpanReader and ArchiveSpanWriter as these capabilities do not exist within grpc storage anymore and are configured externally. 🛑
  • 🛑 This PR deprecates the ArchiveSpanReaderPlugin and ArchvieSpanWriterPlugin 🛑

How was this change tested?

  • CI

Checklist

Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
Comment on lines 244 to 245
ArchiveSpanReader: s.impl.SpanReader() != nil,
ArchiveSpanWriter: s.impl.SpanWriter() != nil,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@yurishkuro should we remove these from the capabilities response altogether?

Copy link
Member

Choose a reason for hiding this comment

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

yes

Copy link
Member

Choose a reason for hiding this comment

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

we can mark them deprecated in the .proto definition and return false here

ArchiveSpanReader: s.impl.ArchiveSpanReader() != nil,
ArchiveSpanWriter: s.impl.ArchiveSpanWriter() != nil,
ArchiveSpanReader: s.impl.SpanReader() != nil,
ArchiveSpanWriter: s.impl.SpanWriter() != nil,
StreamingSpanWriter: s.impl.StreamingSpanWriter() != nil,
}, nil
}

func (s *GRPCHandler) GetArchiveTrace(r *storage_v1.GetTraceRequest, stream storage_v1.ArchiveSpanReaderPlugin_GetArchiveTraceServer) error {
Copy link
Member

Choose a reason for hiding this comment

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

should this return not-implemented error instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@yurishkuro are we okay with making that breaking change?

Copy link
Member

Choose a reason for hiding this comment

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

this will never be called by grpc-storage

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@yurishkuro is there a reason we can't just remove this then?

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.00%. Comparing base (7f72d96) to head (e66496d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6611      +/-   ##
==========================================
- Coverage   96.03%   96.00%   -0.04%     
==========================================
  Files         365      365              
  Lines       20654    20616      -38     
==========================================
- Hits        19836    19792      -44     
- Misses        622      626       +4     
- Partials      196      198       +2     
Flag Coverage Δ
badger_v1 9.92% <0.00%> (+0.03%) ⬆️
badger_v2 1.84% <0.00%> (+<0.01%) ⬆️
cassandra-4.x-v1-manual 15.08% <0.00%> (+0.05%) ⬆️
cassandra-4.x-v2-auto 1.83% <0.00%> (+<0.01%) ⬆️
cassandra-4.x-v2-manual 1.83% <0.00%> (+<0.01%) ⬆️
cassandra-5.x-v1-manual 15.08% <0.00%> (+0.05%) ⬆️
cassandra-5.x-v2-auto 1.83% <0.00%> (+<0.01%) ⬆️
cassandra-5.x-v2-manual 1.83% <0.00%> (+<0.01%) ⬆️
elasticsearch-6.x-v1 19.30% <0.00%> (+0.07%) ⬆️
elasticsearch-7.x-v1 19.38% <0.00%> (+0.07%) ⬆️
elasticsearch-8.x-v1 19.56% <0.00%> (+0.07%) ⬆️
elasticsearch-8.x-v2 1.84% <0.00%> (+<0.01%) ⬆️
grpc_v1 11.04% <100.00%> (-0.14%) ⬇️
grpc_v2 7.89% <100.00%> (-0.16%) ⬇️
kafka-3.x-v1 10.21% <0.00%> (+0.03%) ⬆️
kafka-3.x-v2 1.84% <0.00%> (+<0.01%) ⬆️
memory_v2 1.84% <0.00%> (+<0.01%) ⬆️
opensearch-1.x-v1 19.44% <0.00%> (+0.07%) ⬆️
opensearch-2.x-v1 19.44% <0.00%> (+0.07%) ⬆️
opensearch-2.x-v2 1.84% <0.00%> (+<0.01%) ⬆️
tailsampling-processor 0.48% <0.00%> (+<0.01%) ⬆️
unittests 94.81% <100.00%> (-0.01%) ⬇️

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.

Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
@mahadzaryab1 mahadzaryab1 added the changelog:breaking-change Change that is breaking public APIs or established behavior label Jan 26, 2025
Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
@mahadzaryab1 mahadzaryab1 marked this pull request as ready for review January 26, 2025 22:53
@mahadzaryab1 mahadzaryab1 requested a review from a team as a code owner January 26, 2025 22:53
@dosubot dosubot bot added the area/storage label Jan 26, 2025
@mahadzaryab1 mahadzaryab1 enabled auto-merge (squash) January 26, 2025 22:55
@mahadzaryab1 mahadzaryab1 merged commit 5136f34 into jaegertracing:main Jan 26, 2025
55 checks passed
ekefan pushed a commit to ekefan/jaeger that referenced this pull request Jan 26, 2025
…handler (jaegertracing#6611)

## Which problem is this PR solving?
- Towards jaegertracing#6065

## Description of the changes
- 🛑 This PR deprecates two fields in the `CapabilitiesResponse`;
`ArchiveSpanReader` and `ArchiveSpanWriter` as these capabilities do not
exist within grpc storage anymore and are configured externally. 🛑
- 🛑 This PR deprecates the ArchiveSpanReaderPlugin and
ArchvieSpanWriterPlugin 🛑

## How was this change tested?
- CI

## 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: Mahad Zaryab <mahadzaryab1@gmail.com>
@mahadzaryab1 mahadzaryab1 deleted the grpc-archive-cleanup branch January 26, 2025 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/storage changelog:breaking-change Change that is breaking public APIs or established behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants