-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat: add human-readable formatting to EXPLAIN ANALYZE metrics #18689 #18734
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
feat: add human-readable formatting to EXPLAIN ANALYZE metrics #18689 #18734
Conversation
aa67ff6 to
2e1c52b
Compare
2010YOUY01
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is well structured and tested, thank you!
The explain analyze format looks much nicer now
> explain analyze
select *
from generate_series(10000000) as t1(v1)
where v1 % 2 = 0;
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type | plan |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plan with Metrics | ProjectionExec: expr=[value@0 as v1], metrics=[output_rows=5.00 M, elapsed_compute=148.99µs, output_bytes=76.3 MB] |
| | FilterExec: value@0 % 2 = 0, metrics=[output_rows=5.00 M, elapsed_compute=30.53ms, output_bytes=76.3 MB, selectivity=50% (5.00 M/10.00 M)] |
| | RepartitionExec: partitioning=RoundRobinBatch(14), input_partitions=1, metrics=[output_rows=10.00 M, elapsed_compute=598.09µs, output_bytes=76.3 MB] |
| | LazyMemoryExec: partitions=1, batch_generators=[generate_series: start=0, end=10000000, batch_size=8192], metrics=[output_rows=10.00 M, elapsed_compute=10.25ms, output_bytes=76.3 MB] |
| | |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row(s) fetched.
Elapsed 0.018 seconds.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds human-readable formatting to EXPLAIN ANALYZE metrics to improve readability by displaying large numbers with K, M, B, T suffixes and durations with appropriate time units (ns, µs, ms, s).
Key Changes
- Added
human_readable_count()andhuman_readable_duration()utility functions for formatting numeric values and time durations - Updated metric display implementations (Count, Time, PruningMetrics, RatioMetrics, Gauge) to use the new formatting functions
- Added comprehensive test coverage for the new formatting functions
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| datafusion/execution/src/memory_pool/mod.rs | Added human_readable_count() and human_readable_duration() utility functions with tests |
| datafusion/physical-plan/src/metrics/value.rs | Updated Display implementations for Count, Time, PruningMetrics, RatioMetrics, and Gauge types to use human-readable formatting; added comprehensive tests |
| datafusion/core/tests/physical_optimizer/filter_pushdown/mod.rs | Updated test assertion to expect human-readable format in output (99872 → 99.87 K) |
| Cargo.lock | Standard dependency version updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| assert_eq!(human_readable_count(1_000), "1.00 K"); | ||
| assert_eq!(human_readable_count(10_100), "10.10 K"); | ||
| assert_eq!(human_readable_count(1_532), "1.53 K"); | ||
| assert_eq!(human_readable_count(99_999), "100.00 K"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be displayed as 100.0 K ? With one decimal place ?
| // Format with appropriate precision | ||
| // For values >= 100, show 1 decimal place (e.g., 123.4 K) | ||
| // For values < 100, show 2 decimal places (e.g., 10.12 K) | ||
| if value >= 100.0 { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to round it first to make it consistent (i.e. 99999 -> 100.0 K):
| if value >= 100.0 { | |
| let rounded = (value * 100.0).round() / 100.0; | |
| if rounded >= 100.0 { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, let's leave it to an optional follow-up.
…#18689 (apache#18734) ## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - Closes apache#18689 ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
Which issue does this PR close?
EXPLAIN ANALYZEoutput formatting #18689Rationale for this change
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?