Skip to content

Commit 8bd4db5

Browse files
committed
add NestedLoopJoinExec metrics to user-guide/metrics.md
1 parent efd793b commit 8bd4db5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/source/user-guide/metrics.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ DataFusion operators expose runtime metrics so you can understand where time is
3434
| output_bytes | Memory usage of all output batches. Note: This value may be overestimated. If multiple output `RecordBatch` instances share underlying memory buffers, their sizes will be counted multiple times. |
3535
| output_batches | Total number of output batches the operator produces. |
3636

37+
### BuildProbeJoinMetrics
38+
39+
| Metric | Description |
40+
| ------------------- | ------------------------------------------------------------------- |
41+
| build_time | Total time for collecting build-side of join |
42+
| build_input_batches | Number of batches consumed by build-side |
43+
| build_input_rows | Number of rows consumed by build-side |
44+
| build_mem_used | Memory used by build-side in bytes |
45+
| join_time | Total time for joining probe-side batches to the build-side batches |
46+
| input_batches | Number of batches consumed by probe-side of this operator |
47+
| input_rows | Number of rows consumed by probe-side this operator |
48+
| probe_hit_rate | Fraction of probe rows that found more than one match |
49+
| avg_fanout | Average number of build matches per matched probe row |
50+
3751
## Operator-specific Metrics
3852

3953
### FilterExec
@@ -42,6 +56,12 @@ DataFusion operators expose runtime metrics so you can understand where time is
4256
| ----------- | ----------------------------------------------------------------- |
4357
| selectivity | Selectivity of the filter, calculated as output_rows / input_rows |
4458

59+
### NestedLoopJoinExec
60+
61+
| Metric | Description |
62+
| ----------- | --------------------------------------------------------------- |
63+
| selectivity | Selectivity of the join: output_rows / (left_rows * right_rows) |
64+
4565
## TODO
4666

4767
Add metrics for the remaining operators

0 commit comments

Comments
 (0)