fyrsta7 commented on code in PR #24055:
URL: https://github.com/apache/datafusion/pull/24055#discussion_r3784262761
##########
docs/source/user-guide/metrics.md:
##########
@@ -42,6 +42,25 @@ DataFusion operators expose runtime metrics so you can
understand where time is
| ----------- |
----------------------------------------------------------------- |
| selectivity | Selectivity of the filter, calculated as output_rows /
input_rows |
+### HashJoinExec
+
+`HashJoinExec` also exposes the common `BaselineMetrics`. Its
+`elapsed_compute` metric is the sum of the build-side collection time and the
+subsequent join processing time.
+
+| Metric | Description
|
+| ----------------------- |
---------------------------------------------------------------------------------------------------------
|
+| build_time | Total time spent collecting and building the build
side of the join. |
+| build_input_batches | Number of input batches consumed from the build
side. |
+| build_input_rows | Number of input rows consumed from the build side.
|
+| build_mem_used | Peak memory used by the build side, in bytes.
|
Review Comment:
Thanks for the clarification. I updated the description to say "Peak tracked
memory used by the build side" so it is clear that this metric reflects the
operator\u0027s accounting rather than an allocator-measured process-memory
peak.
##########
docs/source/user-guide/metrics.md:
##########
@@ -42,6 +42,25 @@ DataFusion operators expose runtime metrics so you can
understand where time is
| ----------- |
----------------------------------------------------------------- |
| selectivity | Selectivity of the filter, calculated as output_rows /
input_rows |
+### HashJoinExec
+
+`HashJoinExec` also exposes the common `BaselineMetrics`. Its
+`elapsed_compute` metric is the sum of the build-side collection time and the
+subsequent join processing time.
+
+| Metric | Description
|
+| ----------------------- |
---------------------------------------------------------------------------------------------------------
|
+| build_time | Total time spent collecting and building the build
side of the join. |
+| build_input_batches | Number of input batches consumed from the build
side. |
+| build_input_rows | Number of input rows consumed from the build side.
|
+| build_mem_used | Peak memory used by the build side, in bytes.
|
Review Comment:
Thanks for the clarification. I updated the description to say "Peak tracked
memory used by the build side" so it is clear that this metric reflects the
operator's accounting rather than an allocator-measured process-memory peak.
--
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]
