Add help tooltip to Spark Jobs page.

JoshRosen · JoshRosen · commit 8a2351bd51a2 · 2014-11-11T18:13:30.000-08:00
diff --git a/core/src/main/scala/org/apache/spark/ui/UIUtils.scala b/core/src/main/scala/org/apache/spark/ui/UIUtils.scala
@@ -169,7 +169,8 @@ private[spark] object UIUtils extends Logging {
       title: String,
       content: => Seq[Node],
       activeTab: SparkUITab,
-      refreshInterval: Option[Int] = None): Seq[Node] = {
+      refreshInterval: Option[Int] = None,
+      helpText: Option[String] = None): Seq[Node] = {
 
     val appName = activeTab.appName
     val shortAppName = if (appName.length < 36) appName else appName.take(32) + "..."
@@ -178,6 +179,9 @@ private[spark] object UIUtils extends Logging {
         <a href={prependBaseUri(activeTab.basePath, "/" + tab.prefix)}>{tab.name}</a>
       </li>
     }
+    val helpButton: Seq[Node] = helpText.map { helpText =>
+      <a data-toggle="tooltip" data-placement="bottom" title={helpText}>(?)</a>
+    }.getOrElse(Seq.empty)
 
     <html>
       <head>
@@ -201,6 +205,7 @@ private[spark] object UIUtils extends Logging {
             <div class="span12">
               <h3 style="vertical-align: bottom; display: inline-block;">
                 {title}
+                {helpButton}
               </h3>
             </div>
           </div>
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/AllJobsPage.scala b/core/src/main/scala/org/apache/spark/ui/jobs/AllJobsPage.scala
@@ -147,7 +147,11 @@ private[ui] class AllJobsPage(parent: JobsTab) extends WebUIPage("") {
         <h4 id="completed">Completed Jobs ({completedJobs.size})</h4> ++ completedJobsTable ++
         <h4 id ="failed">Failed Jobs ({failedJobs.size})</h4> ++ failedJobsTable
 
-      UIUtils.headerSparkPage("Spark Jobs", content, parent)
+      val helpText = """A job is triggered by a action, like "count()" or "saveAsTextFile()".""" +
+        " Click on a job's title to see information about the stages of tasks associated with" +
+        " the job."
+
+      UIUtils.headerSparkPage("Spark Jobs", content, parent, helpText = Some(helpText))
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,11 @@ private[ui] class AllJobsPage(parent: JobsTab) extends WebUIPage("") {`
`147`	`147`	`<h4 id="completed">Completed Jobs ({completedJobs.size})</h4> ++ completedJobsTable ++`
`148`	`148`	`<h4 id ="failed">Failed Jobs ({failedJobs.size})</h4> ++ failedJobsTable`
`149`	`149`
`150`		`- UIUtils.headerSparkPage("Spark Jobs", content, parent)`
	`150`	`+ val helpText = """A job is triggered by a action, like "count()" or "saveAsTextFile()".""" +`
	`151`	`+ " Click on a job's title to see information about the stages of tasks associated with" +`
	`152`	`+ " the job."`
	`153`	`+`
	`154`	`+ UIUtils.headerSparkPage("Spark Jobs", content, parent, helpText = Some(helpText))`
`151`	`155`	`}`
`152`	`156`	`}`
`153`	`157`	`}`