diff --git a/docs/source/index.rst b/docs/source/index.rst index a11ca862e4572..6bb3c9485b718 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -122,6 +122,7 @@ To get started, see user-guide/sql/index user-guide/configs user-guide/explain-usage + user-guide/metrics user-guide/faq .. _toc.library-user-guide: diff --git a/docs/source/user-guide/metrics.md b/docs/source/user-guide/metrics.md new file mode 100644 index 0000000000000..f2634b901518b --- /dev/null +++ b/docs/source/user-guide/metrics.md @@ -0,0 +1,37 @@ + + +# Metrics + +DataFusion operators expose runtime metrics so you can understand where time is spent and how much data flows through the pipeline. See more in [EXPLAIN ANALYZE](sql/explain.md#explain-analyze). + +## Common Metrics + +### BaselineMetrics + +`BaselineMetrics` are available in most physical operators to capture common measurements. + +| Metric | Description | +| --------------- | ------------------------------------------------------ | +| elapsed_compute | CPU time the operator actively spends processing work. | +| output_rows | Total number of rows the operator produces. | + +## Operator-specific Metrics + +TODO