spark-webui-WebUIPage.adoc

WebUIPage — Contract of Pages in Web UI

WebUIPage is the contract of web pages of a WebUI that can be rendered in HTML and JSON.

WebUIPage can be:

• attached or detached from a WebUI

• attached to a WebUITab

WebUIPage has a prefix that…​FIXME

package org.apache.spark.ui

abstract class WebUIPage(var prefix: String) {
  def render(request: HttpServletRequest): Seq[Node]
  def renderJson(request: HttpServletRequest): JValue = JNothing
}

Note	WebUIPage is a private[spark] contract.

Table 1. WebUIPage Contract

Method	Description
render	Used exclusively when WebUI is requested to attach a page (and…​FIXME)
renderJson	Used when…​FIXME

Table 2. WebUIPages

WebUIPage	Description
AllExecutionsPage	Used in Spark SQL module
AllJobsPage
AllStagesPage
ApplicationPage	Used in Spark Standalone cluster manager
BatchPage	Used in Spark Streaming module
DriverPage	Used in Spark on Mesos module
EnvironmentPage
ExecutionPage	Used in Spark SQL module
ExecutorsPage
ExecutorThreadDumpPage
HistoryPage	Used in Spark History Server module
JobPage
LogPage	Used in Spark Standalone cluster manager
MasterPage	Used in Spark Standalone cluster manager
MesosClusterPage	Used in Spark on Mesos module
PoolPage
RDDPage
StagePage
StoragePage
StreamingPage	Used in Spark Streaming module
ThriftServerPage	Used in Spark Thrift Server module
ThriftServerSessionPage	Used in Spark Thrift Server module
WorkerPage	Used in Spark Standalone cluster manager