Skip to content

doc: add FilterExec metrics to user-guide/metrics.md #19043

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.

Sign up for GitHub

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

Merged
2010YOUY01 merged 3 commits into from
Dec 3, 2025
Merged

doc: add FilterExec metrics to user-guide/metrics.md #19043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfa7e78
add `FilterExec` metrics to user-guide/metrics.md
2010YOUY01 Dec 2, 2025
5812924
Update datafusion/physical-plan/src/filter.rs
2010YOUY01 Dec 2, 2025
43c275a
Apply suggestions from code review
2010YOUY01 Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions datafusion/physical-plan/src/filter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,10 +686,12 @@ struct FilterExecStream {

/// The metrics for `FilterExec`
struct FilterExecMetrics {
// Common metrics for most operators
/// Common metrics for most operators
baseline_metrics: BaselineMetrics,
// Selectivity of the filter, calculated as output_rows / input_rows
/// Selectivity of the filter, calculated as output_rows / input_rows
selectivity: RatioMetrics,
// Remember to update `docs/source/user-guide/metrics.md` when adding new metrics,
// or modifying metrics comments
}

impl FilterExecMetrics {
Expand Down
10 changes: 9 additions & 1 deletion docs/source/user-guide/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,12 @@ DataFusion operators expose runtime metrics so you can understand where time is

## Operator-specific Metrics

TODO
### FilterExec

| Metric | Description |
| ----------- | ----------------------------------------------------------------- |
| selectivity | Selectivity of the filter, calculated as output_rows / input_rows |

## TODO

Add metrics for the remaining operators
⚡