maropu commented on a change in pull request #31367:
URL: https://github.com/apache/spark/pull/31367#discussion_r566494980
##########
File path: docs/web-ui.md
##########
@@ -404,6 +404,16 @@ Here is the list of SQL metrics:
<tr><td> <code>avg hash probe bucket list iters</code> </td><td> the average
bucket list iterations per lookup during aggregation </td><td> HashAggregate
</td></tr>
<tr><td> <code>data size of build side</code> </td><td> the size of built hash
map </td><td> ShuffledHashJoin </td></tr>
<tr><td> <code>time to build hash map</code> </td><td> the time spent on
building hash map </td><td> ShuffledHashJoin </td></tr>
+<tr><td> <code>time spent executing</code> </td><td> time spent executing the
Python UDF and sending the results back to the executors. It contains time
spent waiting for input queues to fill, when sending data is slow compared to
execution </td><td> BatchEvalPython, ArrowEvalPython, AggregateInPandas,
FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas, WindowsInPandas
</td></tr>
+<tr><td> <code>time spent sending data</code> </td><td> time spent sending
data to the Python workers, this is part of the Python UDF execution and
happens asynchronously using queues </td><td> BatchEvalPython, ArrowEvalPython,
AggregateInPandas, FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas,
WindowsInPandas </td></tr>
+<tr><td> <code>time spent sending code</code> </td><td> time spent sending
Python code to the Python workers </td><td> BatchEvalPython, ArrowEvalPython,
AggregateInPandas, FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas,
WindowsInPandas </td></tr>
+<tr><td> <code>bytes of code sent</code> </td><td> the number of bytes of
serialized Python code sent the to the Python workers </td><td>
BatchEvalPython, ArrowEvalPython, AggregateInPandas, FlaMapGroupsInPandas,
FlatMapsCoGroupsInPandas, MapInPandas, WindowsInPandas </td></tr>
+<tr><td> <code>bytes of data returned</code> </td><td> the number of bytes of
serialized data received back from the Python workers </td><td>
BatchEvalPython, ArrowEvalPython, AggregateInPandas, FlaMapGroupsInPandas,
FlatMapsCoGroupsInPandas, MapInPandas, WindowsInPandas </td></tr>
+<tr><td> <code>bytes of data sent</code> </td><td> the number of bytes of
serialized data sent the to the Python workers </td><td> BatchEvalPython,
ArrowEvalPython, AggregateInPandas, FlaMapGroupsInPandas,
FlatMapsCoGroupsInPandas, MapInPandas, WindowsInPandas </td></tr>
+<tr><td> <code>number of batches returned</code> </td><td> the number of data
batches received back from the Python workers </td><td> BatchEvalPython,
ArrowEvalPython, AggregateInPandas, FlaMapGroupsInPandas,
FlatMapsCoGroupsInPandas, MapInPandas, WindowsInPandas </td></tr>
+<tr><td> <code>number of batches processed</code> </td><td> the number of data
batches sent to the Python workers </td><td> BatchEvalPython, ArrowEvalPython,
AggregateInPandas, FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas,
WindowsInPandas </td></tr>
+<tr><td> <code>number of rows returned</code> </td><td> the number of rows
returned by the Python workers </td><td> BatchEvalPython, ArrowEvalPython,
AggregateInPandas, FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas,
WindowsInPandas </td></tr>
+<tr><td> <code>number of rows processed</code> </td><td> the number rows sent
to the Python workers </td><td> BatchEvalPython, ArrowEvalPython,
AggregateInPandas, FlaMapGroupsInPandas, FlatMapsCoGroupsInPandas, MapInPandas,
WindowsInPandas </td></tr>
Review comment:
For reviews, could you put the screenshot of the updated doc in the PR
description?
##########
File path: python/pyspark/sql/tests/test_pandas_sqlmetrics.py
##########
@@ -0,0 +1,65 @@
+#
+# 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.
+#
+
+import unittest
+
+from pyspark.sql.functions import pandas_udf
+from pyspark.testing.sqlutils import ReusedSQLTestCase, have_pandas,
have_pyarrow, \
+ pandas_requirement_message, pyarrow_requirement_message
+
+
[email protected](
+ not have_pandas or not have_pyarrow,
+ pandas_requirement_message or pyarrow_requirement_message) # type:
ignore[arg-type]
+class PandasSQLMetrics(ReusedSQLTestCase):
+
+ def test_pandas_sql_metrics_basic(self):
+
+ PythonSQLMetrics = [
+ "time spent executing",
+ "time spent sending data",
+ "time spent sending code",
+ "bytes of code sent",
+ "bytes of data returned",
+ "bytes of data sent",
+ "number of batches returned",
+ "number of batches processed",
+ "number of rows returned",
+ "number of rows processed"
+ ]
+
+ @pandas_udf("long")
+ def test_pandas(col1):
+ return col1 * col1
+
+ res = self.spark.range(10).select(test_pandas("id")).collect()
+
+ statusStore = self.spark._jsparkSession.sharedState().statusStore()
+ executionMetrics = statusStore.execution(0).get().metrics().mkString()
+
+ for metric in PythonSQLMetrics:
+ self.assertIn(metric, executionMetrics)
+
Review comment:
nit: one more blank line.
##########
File path:
sql/core/src/main/scala/org/apache/spark/sql/execution/python/PythonSQLMetrics.scala
##########
@@ -0,0 +1,57 @@
+/*
+ * 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.
+ */
+
+package org.apache.spark.sql.execution.python
+
+import org.apache.spark.sql.execution.SparkPlan
+import org.apache.spark.sql.execution.metric.SQLMetrics
+
+private[python] trait PythonSQLMetrics extends SparkPlan {
Review comment:
These plans already extend `SparkPlan` (e.g.,
https://github.com/apache/spark/pull/31367/files#diff-ce3497483dcd52a600e1414d36f15e96f766ea94f3c50f075926716b7e42c724R57),
so could you use self-type instead?
```
private[python] trait PythonSQLMetrics {
self: SparkPlan
...
```
##########
File path: python/pyspark/sql/tests/test_pandas_sqlmetrics.py
##########
@@ -0,0 +1,65 @@
+#
+# 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.
+#
+
+import unittest
+
+from pyspark.sql.functions import pandas_udf
+from pyspark.testing.sqlutils import ReusedSQLTestCase, have_pandas,
have_pyarrow, \
+ pandas_requirement_message, pyarrow_requirement_message
+
+
[email protected](
+ not have_pandas or not have_pyarrow,
+ pandas_requirement_message or pyarrow_requirement_message) # type:
ignore[arg-type]
+class PandasSQLMetrics(ReusedSQLTestCase):
Review comment:
Could you add tests in a Scala side (e.g., `SQLMetricsSuite`), too?
##########
File path:
sql/core/src/main/scala/org/apache/spark/sql/execution/python/PythonSQLMetrics.scala
##########
@@ -0,0 +1,57 @@
+/*
+ * 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.
+ */
+
+package org.apache.spark.sql.execution.python
+
+import org.apache.spark.sql.execution.SparkPlan
+import org.apache.spark.sql.execution.metric.SQLMetrics
+
+private[python] trait PythonSQLMetrics extends SparkPlan {
+ override val metrics = Map(
Review comment:
If you want to implement many metrics, how about using `Map[String,
SQLMetric]` instead? (see `ShuffledRowRDD`)
##########
File path:
sql/core/src/main/scala/org/apache/spark/sql/execution/python/PythonUDFRunner.scala
##########
@@ -31,10 +32,17 @@ import org.apache.spark.sql.internal.SQLConf
class PythonUDFRunner(
funcs: Seq[ChainedPythonFunctions],
evalType: Int,
- argOffsets: Array[Array[Int]])
+ argOffsets: Array[Array[Int]],
+ pythonExecTime: SQLMetric,
+ pythonDataSerializeTime: SQLMetric,
+ pythonCodeSerializeTime: SQLMetric,
+ pythonCodeSent: SQLMetric,
+ pythonDataReceived: SQLMetric,
+ pythonDataSent: SQLMetric,
+ pythonNumBatchesReceived: SQLMetric,
+ pythonNumBatchesSent: SQLMetric)
extends BasePythonRunner[Array[Byte], Array[Byte]](
funcs, evalType, argOffsets) {
-
Review comment:
nit: revert the unnecessary change
##########
File path:
sql/core/src/main/scala/org/apache/spark/sql/execution/python/PythonArrowOutput.scala
##########
@@ -26,16 +26,22 @@ import org.apache.arrow.vector.VectorSchemaRoot
import org.apache.arrow.vector.ipc.ArrowStreamReader
import org.apache.spark.{SparkEnv, TaskContext}
-import org.apache.spark.api.python.{BasePythonRunner, SpecialLengths}
+import org.apache.spark.api.python.{BasePythonRunner, ChainedPythonFunctions,
SpecialLengths}
+import org.apache.spark.sql.execution.metric.SQLMetric
import org.apache.spark.sql.types.StructType
import org.apache.spark.sql.util.ArrowUtils
import org.apache.spark.sql.vectorized.{ArrowColumnVector, ColumnarBatch,
ColumnVector}
-/**
- * A trait that can be mixed-in with [[BasePythonRunner]]. It implements the
logic from
- * Python (Arrow) to JVM (ColumnarBatch).
- */
-private[python] trait PythonArrowOutput { self: BasePythonRunner[_,
ColumnarBatch] =>
+// An abstract class implementing the logic from Python (Arrow) to JVM
(ColumnarBatch).
+private[python] abstract class PythonArrowOutput[IN](
Review comment:
Could you avoid this change? How about writing it like this?
```
private[python] trait PythonArrowOutput { self: BasePythonRunner[_,
ColumnarBatch] =>
def pythonDataReceived: SQLMetric
def pythonExecTime: SQLMetric
def pythonNumRowsReceived: SQLMetric
def pythonNumBatchesReceived: SQLMetric
...
```
Then, can you override them in the `ArrowPythonRunner` side?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
