Adds Trace and Summary to CLI instrumented stores #18064
Merged
+75
−31
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 issue does this PR close?
This does not fully close, but is an incremental building block component for:
datafusion-cli
] Add a way to see what object store requests are made #17207The full context of how this code is likely to progress can be seen in the POC for this effort:
Rationale for this change
For queries that have many calls to an instrumented object store generating a full output of all the calls and the summary of those calls could end up generating thousands of lines of output. Allowing users to only see a summary for these cases will help ensure the instrumented object store does not completely dominate the output for a query.
What changes are included in this PR?
Trace
to improve clarityAre these changes tested?
Yes. Additional unit tests have been added, and the existing integration test has been augmented to exercise the new option(s).
Example functional output:
./datafusion-cli --object-store-profiling trace
Are there any user-facing changes?
Yes. An existing user option in the form of a CLI flag and the associated command was changed. The user documentation has been updated to reflect these changes.
cc @alamb
(I believe the previous PR that was merged for this effort was the last major set of core functionality! 🎉 The remaining PRs should all be pretty concise and just fill out the small bits of missing implementation.)