Back to Datafusion

Metrics

docs/source/user-guide/metrics.md

53.1.02.7 KB
Original Source
<!--- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

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.

Common Metrics

BaselineMetrics

BaselineMetrics are available in most physical operators to capture common measurements.

MetricDescription
elapsed_computeCPU time the operator actively spends processing work.
output_rowsTotal number of rows the operator produces.
output_bytesMemory 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.
output_batchesTotal number of output batches the operator produces.

Operator-specific Metrics

FilterExec

MetricDescription
selectivitySelectivity of the filter, calculated as output_rows / input_rows

TODO

Add metrics for the remaining operators