forked from apache/spark
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-44394][CONNECT][WEBUI] Add a Spark UI page for Spark Connect
## What changes were proposed in this pull request? Add a new Spark UI page to display session and execution information for Spark Connect. This builds of the work in SPARK-43923 (apache#41443) that adds the relevant SparkListenerEvents and mirrors the ThriftServerPage in the Spark UI for JDBC/ODBC. <img width="1709" alt="Screenshot 2023-07-27 at 11 29 22 PM" src="https://github.com/apache/spark/assets/65624911/934b7c69-3b44-460b-8fbb-36a9eb3f0798"> <img width="1716" alt="Screenshot 2023-07-27 at 11 29 15 PM" src="https://github.com/apache/spark/assets/65624911/33dbe6ab-44bf-49a5-ad4c-5ba4a476a1f0"> ### Why are the changes needed? This gives users a way to access session and execution information for Spark Connect via the UI and provides the frontend interface for the related SparkListenerEvents. ### Does this PR introduce _any_ user-facing change? Yes, it will add a new tab/page in the Spark UI ### How was this patch tested? Unit tests Closes apache#41964 from jasonli-db/spark-connect-ui. Authored-by: Jason Li <jason.li@databricks.com> Signed-off-by: Gengliang Wang <gengliang@apache.org>
- Loading branch information
1 parent
11b3b23
commit f8786f0
Showing
20 changed files
with
1,789 additions
and
18 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
131 changes: 131 additions & 0 deletions
131
...ver/src/main/scala/org/apache/spark/sql/connect/ui/SparkConnectServerAppStatusStore.scala
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * 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.connect.ui | ||
|
|
||
| import scala.collection.mutable | ||
| import scala.collection.mutable.ArrayBuffer | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonIgnore | ||
|
|
||
| import org.apache.spark.status.KVUtils | ||
| import org.apache.spark.status.KVUtils.KVIndexParam | ||
| import org.apache.spark.util.kvstore.{KVIndex, KVStore} | ||
|
|
||
| class SparkConnectServerAppStatusStore(store: KVStore) { | ||
| def getSessionList: Seq[SessionInfo] = { | ||
| KVUtils.viewToSeq(store.view(classOf[SessionInfo])) | ||
| } | ||
|
|
||
| def getExecutionList: Seq[ExecutionInfo] = { | ||
| KVUtils.viewToSeq(store.view(classOf[ExecutionInfo])) | ||
| } | ||
|
|
||
| def getOnlineSessionNum: Int = { | ||
| KVUtils.count(store.view(classOf[SessionInfo]))(_.finishTimestamp == 0) | ||
| } | ||
|
|
||
| def getSession(sessionId: String): Option[SessionInfo] = { | ||
| try { | ||
| Some(store.read(classOf[SessionInfo], sessionId)) | ||
| } catch { | ||
| case _: NoSuchElementException => None | ||
| } | ||
| } | ||
|
|
||
| def getExecution(executionId: String): Option[ExecutionInfo] = { | ||
| try { | ||
| Some(store.read(classOf[ExecutionInfo], executionId)) | ||
| } catch { | ||
| case _: NoSuchElementException => None | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * When an error or a cancellation occurs, we set the finishTimestamp of the statement. | ||
| * Therefore, when we count the number of running statements, we need to exclude errors and | ||
| * cancellations and count all statements that have not been closed so far. | ||
| */ | ||
| def getTotalRunning: Int = { | ||
| KVUtils.count(store.view(classOf[ExecutionInfo]))(_.isExecutionActive) | ||
| } | ||
|
|
||
| def getSessionCount: Long = { | ||
| store.count(classOf[SessionInfo]) | ||
| } | ||
|
|
||
| def getExecutionCount: Long = { | ||
| store.count(classOf[ExecutionInfo]) | ||
| } | ||
| } | ||
|
|
||
| private[connect] class SessionInfo( | ||
| @KVIndexParam val sessionId: String, | ||
| val startTimestamp: Long, | ||
| val userId: String, | ||
| val finishTimestamp: Long, | ||
| val totalExecution: Long) { | ||
| @JsonIgnore @KVIndex("finishTime") | ||
| private def finishTimeIndex: Long = if (finishTimestamp > 0L) finishTimestamp else -1L | ||
| def totalTime: Long = { | ||
| if (finishTimestamp == 0L) { | ||
| System.currentTimeMillis - startTimestamp | ||
| } else { | ||
| finishTimestamp - startTimestamp | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private[connect] class ExecutionInfo( | ||
| @KVIndexParam val jobTag: String, | ||
| val statement: String, | ||
| val sessionId: String, | ||
| val startTimestamp: Long, | ||
| val userId: String, | ||
| val operationId: String, | ||
| val sparkSessionTags: Set[String], | ||
| val finishTimestamp: Long, | ||
| val closeTimestamp: Long, | ||
| val detail: String, | ||
| val state: ExecutionState.Value, | ||
| val jobId: ArrayBuffer[String], | ||
| val sqlExecId: mutable.Set[String]) { | ||
| @JsonIgnore @KVIndex("finishTime") | ||
| private def finishTimeIndex: Long = if (finishTimestamp > 0L && !isExecutionActive) { | ||
| finishTimestamp | ||
| } else -1L | ||
|
|
||
| @JsonIgnore @KVIndex("isExecutionActive") | ||
| def isExecutionActive: Boolean = { | ||
| state == ExecutionState.STARTED || | ||
| state == ExecutionState.COMPILED || | ||
| state == ExecutionState.READY | ||
| } | ||
|
|
||
| def totalTime(endTime: Long): Long = { | ||
| if (endTime == 0L) { | ||
| System.currentTimeMillis - startTimestamp | ||
| } else { | ||
| endTime - startTimestamp | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private[connect] object ExecutionState extends Enumeration { | ||
| val STARTED, COMPILED, READY, CANCELED, FAILED, FINISHED, CLOSED = Value | ||
| type ExecutionState = Value | ||
| } |
41 changes: 41 additions & 0 deletions
41
...rc/main/scala/org/apache/spark/sql/connect/ui/SparkConnectServerHistoryServerPlugin.scala
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * 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.connect.ui | ||
|
|
||
| import org.apache.spark.SparkConf | ||
| import org.apache.spark.scheduler.SparkListener | ||
| import org.apache.spark.status.{AppHistoryServerPlugin, ElementTrackingStore} | ||
| import org.apache.spark.ui.SparkUI | ||
|
|
||
| class SparkConnectServerHistoryServerPlugin extends AppHistoryServerPlugin { | ||
|
|
||
| override def createListeners( | ||
| conf: SparkConf, | ||
| store: ElementTrackingStore): Seq[SparkListener] = { | ||
| Seq(new SparkConnectServerListener(store, conf)) | ||
| } | ||
|
|
||
| override def setupUI(ui: SparkUI): Unit = { | ||
| val store = new SparkConnectServerAppStatusStore(ui.store.store) | ||
| if (store.getSessionCount > 0) { | ||
| new SparkConnectServerTab(store, ui) | ||
| } | ||
| } | ||
|
|
||
| override def displayOrder: Int = 3 | ||
| } |
Oops, something went wrong.