You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "yaooqinn (via GitHub)" <gi...@apache.org> on 2023/09/13 10:08:54 UTC
[GitHub] [spark] yaooqinn opened a new pull request, #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
yaooqinn opened a new pull request, #42904:
URL: https://github.com/apache/spark/pull/42904
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR adds a point-and-click interface that reuses the STATUS column on the stage tab/page to enable trigger rendering of the newly added TaskThreadDumpPage.
As you can see above, the point-and-click interface shows only for RUNNING tasks.
During rendering, it will locate the executor by executorId and send a TaskThreadDump message to it to fetch the thread info by taskId. It then displays
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #42904:
URL: https://github.com/apache/spark/pull/42904#issuecomment-1718697343
cc @sarutak @dongjoon-hyun @srowen @cloud-fan @HyukjinKwon, please help me review this feature when you have time, thanks
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1325335543
##########
core/src/main/resources/org/apache/spark/ui/static/stagepage.js:
##########
@@ -849,7 +856,18 @@ $(document).ready(function () {
{data: "partitionId", name: "Index"},
{data : "taskId", name: "ID"},
{data : "attempt", name: "Attempt"},
- {data : "status", name: "Status"},
+ {
+ data : (row, _ignored_type) => {
+ if (taskThreadDumpEnabled && row.status === "RUNNING") {
Review Comment:
Yes, Live only, SC is required for display.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1325338571
##########
core/src/main/scala/org/apache/spark/scheduler/SchedulerBackend.scala:
##########
@@ -53,6 +54,8 @@ private[spark] trait SchedulerBackend {
reason: String): Unit =
throw new UnsupportedOperationException
+ def getTaskThreadDump(taskId: Long, executorId: String): Option[ThreadStackTrace]
Review Comment:
Currently, it depends on the `spark.rpc.askTimeout/spark.network.timeout`, I am not sure if we need a separate timeout key for some particular case like here
##########
core/src/main/scala/org/apache/spark/scheduler/SchedulerBackend.scala:
##########
@@ -53,6 +54,8 @@ private[spark] trait SchedulerBackend {
reason: String): Unit =
throw new UnsupportedOperationException
+ def getTaskThreadDump(taskId: Long, executorId: String): Option[ThreadStackTrace]
Review Comment:
Currently, it depends on the `spark.rpc.askTimeout/spark.network.timeout`, I am not sure if we need a separate timeout key for some particular cases like here
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] mridulm commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "mridulm (via GitHub)" <gi...@apache.org>.
mridulm commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1325321480
##########
core/src/main/scala/org/apache/spark/scheduler/SchedulerBackend.scala:
##########
@@ -53,6 +54,8 @@ private[spark] trait SchedulerBackend {
reason: String): Unit =
throw new UnsupportedOperationException
+ def getTaskThreadDump(taskId: Long, executorId: String): Option[ThreadStackTrace]
Review Comment:
Do we want to specify a timeout here (and propagate it) ? In case executor is severely loaded.
This is currently not being done for executor thread dumps as well though ...
##########
core/src/main/resources/org/apache/spark/ui/static/stagepage.js:
##########
@@ -849,7 +856,18 @@ $(document).ready(function () {
{data: "partitionId", name: "Index"},
{data : "taskId", name: "ID"},
{data : "attempt", name: "Attempt"},
- {data : "status", name: "Status"},
+ {
+ data : (row, _ignored_type) => {
+ if (taskThreadDumpEnabled && row.status === "RUNNING") {
Review Comment:
To confirm, this will show up only in live UI (due to `StagesTab,threadDumpEnabled`), right ?.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1326735084
##########
core/src/main/scala/org/apache/spark/ui/jobs/TaskThreadDumpPage.scala:
##########
@@ -0,0 +1,109 @@
+/*
+ * 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.ui.jobs
+
+import javax.servlet.http.HttpServletRequest
+
+import scala.xml.{Node, Text}
+
+import org.apache.spark.SparkContext
+import org.apache.spark.ui.{SparkUITab, UIUtils, WebUIPage}
+
+private[spark] class TaskThreadDumpPage(
+ parent: SparkUITab,
+ sc: Option[SparkContext]) extends WebUIPage("taskThreadDump") {
+
+ private def executorThreadDumpUrl(
+ request: HttpServletRequest,
+ executorId: String,
+ blockingThreadId: Long): String = {
+ val uiRoot = UIUtils.prependBaseUri(request, parent.basePath)
+ s"$uiRoot/executors/?executorId=$executorId#${blockingThreadId}_td_id"
+ }
+
+ override def render(request: HttpServletRequest): Seq[Node] = {
+ val executorId = Option(request.getParameter("executorId")).map { executorId =>
+ UIUtils.decodeURLParameter(executorId)
+ }.getOrElse {
+ throw new IllegalArgumentException(s"Missing executorId parameter")
+ }
+ val taskId = Option(request.getParameter("taskId")).map { taskId =>
+ val decoded = UIUtils.decodeURLParameter(taskId)
+ decoded.toLong
+ }.getOrElse {
+ throw new IllegalArgumentException(s"Missing executorId parameter")
Review Comment:
```suggestion
throw new IllegalArgumentException(s"Missing taskId parameter")
```
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn closed pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn closed pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
URL: https://github.com/apache/spark/pull/42904
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #42904:
URL: https://github.com/apache/spark/pull/42904#issuecomment-1718745947
Thank @mridulm for the check
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #42904:
URL: https://github.com/apache/spark/pull/42904#issuecomment-1720406726
Thank you @mridulm, pending CI
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] dongjoon-hyun commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1326772213
##########
core/src/main/scala/org/apache/spark/status/api/v1/OneApplicationResource.scala:
##########
@@ -52,18 +52,24 @@ private[v1] class AbstractApplicationResource extends BaseAppResource {
@Path("executors")
def executorList(): Seq[ExecutorSummary] = withUI(_.store.executorList(true))
- @GET
- @Path("executors/{executorId}/threads")
- def threadDump(@PathParam("executorId") execId: String): Array[ThreadStackTrace] = withUI { ui =>
+ private def checkExecutorId(execId: String): Unit = {
Review Comment:
If you don't mind, could you move these two new private methods, `checkExecutorId` and `checkAndGetSparkContext` at the end of this class in order to reduce the diff, please?
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1326778557
##########
core/src/main/scala/org/apache/spark/status/api/v1/OneApplicationResource.scala:
##########
@@ -52,18 +52,24 @@ private[v1] class AbstractApplicationResource extends BaseAppResource {
@Path("executors")
def executorList(): Seq[ExecutorSummary] = withUI(_.store.executorList(true))
- @GET
- @Path("executors/{executorId}/threads")
- def threadDump(@PathParam("executorId") execId: String): Array[ThreadStackTrace] = withUI { ui =>
+ private def checkExecutorId(execId: String): Unit = {
Review Comment:
thanks, @dongjoon-hyun, it looks much better
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] dongjoon-hyun commented on a diff in pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #42904:
URL: https://github.com/apache/spark/pull/42904#discussion_r1326838058
##########
core/src/main/scala/org/apache/spark/status/api/v1/OneApplicationResource.scala:
##########
@@ -172,6 +180,18 @@ private[v1] class AbstractApplicationResource extends BaseAppResource {
classOf[OneApplicationAttemptResource]
}
+ private def checkExecutorId(execId: String): Unit = {
+ if (execId != SparkContext.DRIVER_IDENTIFIER && !execId.forall(Character.isDigit)) {
+ throw new BadParameterException(
+ s"Invalid executorId: neither '${SparkContext.DRIVER_IDENTIFIER}' nor number.")
+ }
+ }
+
+ private def checkAndGetSparkContext(): SparkContext = withUI { ui =>
+ ui.sc.getOrElse {
+ throw new ServiceUnavailable("Thread dumps not available through the history server.")
+ }
+ }
Review Comment:
Thank you so much.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] yaooqinn commented on pull request #42904: [SPARK-45151][CORE][UI] Task Level Thread Dump Support
Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #42904:
URL: https://github.com/apache/spark/pull/42904#issuecomment-1721030343
The second last commits passed CI and the last is a minor.
Thanks @mridulm and @dongjoon-hyun for the review
Merged to master
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org