This is an automated email from the ASF dual-hosted git repository.
marong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new d1f48d7e94 [VL] Add missing doc for
spark.gluten.sql.columnar.backend.velox.showTaskMetricsWhenFinished (#9738)
d1f48d7e94 is described below
commit d1f48d7e948e5ce161cd29d6d6eb1ade3272ae5d
Author: Rong Ma <[email protected]>
AuthorDate: Mon May 26 03:36:06 2025 +0800
[VL] Add missing doc for
spark.gluten.sql.columnar.backend.velox.showTaskMetricsWhenFinished (#9738)
---
docs/Configuration.md | 2 ++
docs/get-started/Velox.md | 6 ++++--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 1141b58ebf..4ab9285fac 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -111,6 +111,8 @@ The following configurations are related to Velox settings.
| spark.gluten.auto.adjustStageResource.enabled |
Experimental: If enabled, gluten will try to set the stage resource according
to stage execution plan. NOTE: Only workes when aqe is enabled at the same
time. | false |
| spark.gluten.auto.adjustStageResources.heap.ratio |
Experimental: Increase executor heap memory when match adjust stage resource
rule.
| 2.0d |
| spark.gluten.auto.adjustStageResources.fallenNode.ratio.threshold |
Experimental: Increase executor heap memory when stage contains fallen node
count exceeds the total node count ratio.
| 0.5d |
+| spark.gluten.sql.columnar.backend.velox.showTaskMetricsWhenFinished | Print
Velox task metrics after the task finishes.
|
false |
+
Additionally, you can control the configurations of gluten at thread level by
local property.
diff --git a/docs/get-started/Velox.md b/docs/get-started/Velox.md
index c40a1ebb77..b66649bc98 100644
--- a/docs/get-started/Velox.md
+++ b/docs/get-started/Velox.md
@@ -531,8 +531,10 @@ Native Plan:
## Native Plan with Stats
-Gluten supports print native plan with stats to executor system output stream
by setting `--conf spark.gluten.sql.debug=true`.
-Note that, the plan string with stats is task level which may cause executor
log size big. Here is an example, how Gluten show the native plan string with
stats.
+Gluten supports print native plan with statistics to executor system output
stream by setting
+`--conf
spark.gluten.sql.columnar.backend.velox.showTaskMetricsWhenFinished=true` or
`--conf spark.gluten.sql.debug=true`.
+Note that the plan string with statistics is task level, which may increase
the size of the executor logs.
+Below is an example of how Gluten displays the native plan string with
statistics.
```
I20231121 10:19:42.348845 90094332 WholeStageResultIterator.cc:220] Native
Plan with stats for: [Stage: 1 TID: 16]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
