Add resultsObserver to ScatterConn #16638
Merged
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
Updates ScatterConn's ExecuteMultiShard and StreamExecuteMulti methods to accept a results observer parameter. These methods call resultsObserver#observe with every sqltypes.Result object returned from the underlying shards. This makes it straightforward to add instrumentation that needs access to the individual results actually returned from the shards, not just the Result object returned to the client which may or may not include data from all the shards This PR adds the resultObserver, but it is set to a nullResultsObserver so it is effectively a no-op. Having this extensibility will make it much easier for downstream forks to add instrumentation as needed. Signed-off-by: Rafer Hazen <rafer@ralua.com>
Signed-off-by: Rafer Hazen <rafer@ralua.com>
rafer
requested review from
harshit-gangal,
systay,
frouioui and
GuptaManan100
as code owners
Review ChecklistHello reviewers! 👋 Please follow this checklist when reviewing this Pull Request. General
Tests
Documentation
New flags
If a workflow is added or modified:
Backward compatibility
|
vitess-bot
bot
added
NeedsBackportReason
rafer
removed
NeedsDescriptionUpdate
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #16638 +/- ##
==========================================
+ Coverage 68.98% 69.00% +0.02%
==========================================
Files 1562 1564 +2
Lines 200697 202029 +1332
==========================================
+ Hits 138446 139411 +965
- Misses 62251 62618 +367 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Rafer Hazen <rafer@ralua.com>
Signed-off-by: Rafer Hazen <rafer@ralua.com>
Signed-off-by: Rafer Hazen <rafer@ralua.com>
…ter-conn-results Signed-off-by: Rafer Hazen <rafer@ralua.com>
…ter-conn-results Signed-off-by: Rafer Hazen <rafer@ralua.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
systay
reviewed
Aug 29, 2024
systay
approved these changes
Aug 29, 2024
Signed-off-by: Rafer Hazen <rafer@ralua.com>
frouioui
approved these changes
Aug 29, 2024
5 tasks
Comment on lines
+273
to
+276
| if innerqr != nil { | ||
| resultsObserver.observe(innerqr) | ||
| } | ||
|
|
There was a problem hiding this comment.
Here it is given that innerqr will not be nil.
Just below, we append the result to the output result set as-sis without checking.
Comment on lines
+76
to
+78
| resultsObserver interface { | ||
| observe(*sqltypes.Result) | ||
| } |
There was a problem hiding this comment.
should this method not take in the shard information to track where this result set comes from?
5 tasks
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.
Description
Updates
ScatterConn'sExecuteMultiShardandStreamExecuteMultimethods to accept a results observer parameter. These methods callresultsObserver#observewith everysqltypes.Resultreturned from the underlying shards. This makes it straightforward to add instrumentation that needs access to the individual results actually returned from the shards, not just the Result object returned to the client which may or may not include data from all the shard resultsThis PR adds the
resultObserver, but it is set to a nullResultsObserver so it is effectively a no-op. Having this extensibility will make it much for downstream forks to add instrumentation as needed.Related Issue(s)
closes #16481
Checklist
Deployment Notes
None