spark-api-UIRoot.adoc

UIRoot — Contract for Root Contrainers of Application UI Information

UIRoot is the contract of the root containers for application UI information.

package org.apache.spark.status.api.v1

trait UIRoot {
  // only required methods that have no implementation
  // the others follow
  def withSparkUI[T](appId: String, attemptId: Option[String])(fn: SparkUI => T): T
  def getApplicationInfoList: Iterator[ApplicationInfo]
  def getApplicationInfo(appId: String): Option[ApplicationInfo]
  def securityManager: SecurityManager
}

Note	UIRoot is a private[spark] contract.

Table 1. UIRoot Contract

Method	Description
getApplicationInfo	Used when…​FIXME
getApplicationInfoList	Used when…​FIXME
securityManager	Used when…​FIXME
withSparkUI	Used exclusively when BaseAppResource is requested withUI

Table 2. UIRoots

UIRoot	Description
HistoryServer	Application UI for active and completed Spark applications (i.e. Spark applications that are still running or have already finished)
SparkUI	Application UI for an active Spark application (i.e. a Spark application that is still running)

writeEventLogs Method

writeEventLogs(appId: String, attemptId: Option[String], zipStream: ZipOutputStream): Unit

writeEventLogs…​FIXME

Note	writeEventLogs is used when…​FIXME