Add Python bindings for accessing ExecutionMetrics#1381
Open
ShreyeshArangath wants to merge 2 commits intoapache:mainfrom
Open
Add Python bindings for accessing ExecutionMetrics#1381ShreyeshArangath wants to merge 2 commits intoapache:mainfrom
ShreyeshArangath wants to merge 2 commits intoapache:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #1379
Rationale for this change
Today, DataFusion Python only exposes execution metrics through formatted console output via
explain(analyze=True). This makes it difficult to programmatically inspect execution behavior.There is currently no structured python API to access per-operator metrics such as
output_rows,elapsed_compute,spill_countand other runtime metrics collected during execution.This PR introduces APIs to surface the execution metrics, mirroring the Rust API in
datafusion::physical_plan::metrics.What changes are included in this PR?
PyDataFrameso the physical plan used during execution is retained and available for metrics access.metrics()method and addedcollect_metrics()helper to walk the execution plan tree and aggregate metrics from all operators.Are there any user-facing changes?
Users can now programmatically access execution metrics