| <!--- |
| 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](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. | |
| | 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. | |
| | output_batches | Total number of output batches the operator produces. | |
| |
| ## Operator-specific Metrics |
| |
| TODO |
