Skip to content

[SPARK-49007][CORE] Improve MasterPage to support custom title #47491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dongjoon-hyun wants to merge 1 commit into from
Closed

[SPARK-49007][CORE] Improve MasterPage to support custom title #47491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion core/src/main/scala/org/apache/spark/deploy/master/ui/MasterPage.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ import org.apache.spark.deploy.DeployMessages.{KillDriverResponse, MasterStateRe
import org.apache.spark.deploy.JsonProtocol
import org.apache.spark.deploy.StandaloneResourceUtils._
import org.apache.spark.deploy.master._
import org.apache.spark.internal.config.UI.MASTER_UI_TITLE
import org.apache.spark.ui.{UIUtils, WebUIPage}
import org.apache.spark.util.Utils

private[ui] class MasterPage(parent: MasterWebUI) extends WebUIPage("") {
private val master = parent.masterEndpointRef
private val title = parent.master.conf.get(MASTER_UI_TITLE)
private val jsonFieldPattern = "/json/([a-zA-Z]+).*".r

def getMasterState: MasterStateResponse = {
Expand Down Expand Up @@ -266,7 +268,7 @@ private[ui] class MasterPage(parent: MasterWebUI) extends WebUIPage("") {
}
</div>;

UIUtils.basicSparkPage(request, content, "Spark Master at " + state.uri)
UIUtils.basicSparkPage(request, content, title.getOrElse("Spark Master at " + state.uri))
}

private def workerRow(showResourceColumn: Boolean): WorkerInfo => Seq[Node] = worker => {
Expand Down
7 changes: 7 additions & 0 deletions core/src/main/scala/org/apache/spark/internal/config/UI.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,13 @@ private[spark] object UI {
.checkValues(Set("ALLOW", "LOCAL", "DENY"))
.createWithDefault("LOCAL")

val MASTER_UI_TITLE = ConfigBuilder("spark.master.ui.title")
.version("4.0.0")
.doc("Specifies the title of the Master UI page. If unset, `Spark Master at <MasterURL>` " +
"is used by default.")
.stringConf
.createOptional

val UI_SQL_GROUP_SUB_EXECUTION_ENABLED = ConfigBuilder("spark.ui.groupSQLSubExecutionEnabled")
.doc("Whether to group sub executions together in SQL UI when they belong to the same " +
"root execution")
Expand Down
18 changes: 18 additions & 0 deletions core/src/test/scala/org/apache/spark/deploy/master/MasterWorkerUISuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,22 @@ class MasterWorkerUISuite extends MasterSuiteBase {
System.getProperties().remove("spark.ui.proxyBase")
}
}

test("SPARK-49007: Support custom master web ui title") {
implicit val formats = org.json4s.DefaultFormats
val title = "Spark Custom Title"
val conf = new SparkConf().set(MASTER_UI_TITLE, title)
val localCluster = LocalSparkCluster(2, 2, 512, conf)
localCluster.start()
val masterUrl = s"http://${Utils.localHostNameForURI()}:${localCluster.masterWebUIPort}"
try {
eventually(timeout(50.seconds), interval(100.milliseconds)) {
val html = Utils
.tryWithResource(Source.fromURL(s"$masterUrl/"))(_.getLines().mkString("\n"))
html should include (title)
}
} finally {
localCluster.stop()
}
}
}