2010YOUY01 opened a new pull request, #23140:
URL: https://github.com/apache/datafusion/pull/23140
## 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 #123`
indicates that this PR will close issue #123.
-->
- Closes #.
## 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.
-->
See reproducer in `datafusion-cli`:
```sh
yongting@Yongtings-MacBook-Pro-2 ~/C/d/datafusion (hj-mem-fix *)>
datafusion-cli
DataFusion CLI v54.0.0
> set datafusion.explain.analyze_categories = 'bytes';
0 row(s) fetched.
Elapsed 0.001 seconds.
> explain analyze
select *
from generate_series(100000000) as t1(v1)
join generate_series(100000000) as t2(v1)
on t1.v1=t2.v1;
+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type | plan
|
+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plan with Metrics | HashJoinExec: mode=Partitioned, join_type=Inner,
on=[(v1@0, v1@0)], metrics=[output_bytes=1526.7 MB, build_mem_used=2.80 B]
|
| | RepartitionExec: partitioning=Hash([v1@0], 14),
input_partitions=1, maintains_sort_order=true, metrics=[output_bytes=763.4 MB,
spilled_bytes=0.0 B] |
| | ProjectionExec: expr=[value@0 as v1],
metrics=[output_bytes=763.0 MB]
|
| | LazyMemoryExec: partitions=1,
batch_generators=[generate_series: start=0, end=100000000, batch_size=8192],
metrics=[output_bytes=763.0 MB] |
| | RepartitionExec: partitioning=Hash([v1@0], 14),
input_partitions=1, maintains_sort_order=true, metrics=[output_bytes=763.4 MB,
spilled_bytes=0.0 B] |
| | ProjectionExec: expr=[value@0 as v1],
metrics=[output_bytes=763.0 MB]
|
| | LazyMemoryExec: partitions=1,
batch_generators=[generate_series: start=0, end=100000000, batch_size=8192],
metrics=[output_bytes=763.0 MB] |
| |
|
+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row(s) fetched.
Elapsed 1.040 seconds.
```
See `HashJoinExec: ... build_mem_used=2.80 B`, it actually means 2.8 billion
bytes, but it looks quite misleading. This PR fixes it:
```sh
+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type | plan
|
+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plan with Metrics | HashJoinExec: mode=Partitioned, join_type=Inner,
on=[(v1@0, v1@0)], metrics=[output_bytes=1526.7 MB, build_mem_used=2.6 GB]
```
The reason is those metrics are tracking peak memory usage for a operator in
the query lifecycle, so it's using `Gauge` metrics type, but how to choose
display format become tricky (bytes or count?)
This PR adds a new `Metric` type, that wraps the existing `Gauge`, and use
it to represent 'gauge for memory bytes', this fixes the bytes display issue.
## 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.
-->
1. Introduce `MetricValue::PeakMemoryUsage` to address the above issue
2. Use this metric type for applicable metrics
3. Add slts for testing.
## 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
4. 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.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
