Skip to content

Apache DataFusion SQL Query Engine

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

Yongting You653caa143aa5
diff --git a/datafusion/physical-plan/src/filter.rs b/datafusion/physical-plan/src/filter.rs
index 7ea664757d..addabb5036 100644
--- a/datafusion/physical-plan/src/filter.rs
+++ b/datafusion/physical-plan/src/filter.rs
@@ -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 {
diff --git a/docs/source/user-guide/metrics.md b/docs/source/user-guide/metrics.md
index 43bfcd2afe..7e0363f4ce 100644
--- a/docs/source/user-guide/metrics.md
+++ b/docs/source/user-guide/metrics.md
@@ -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