Class/Object

org.apache.spark.deploy.history

HistoryServer

Related Docs: object HistoryServer | package history

Permalink

class HistoryServer extends WebUI with Logging with UIRoot

A web server that renders SparkUIs of completed applications.

For the standalone mode, MasterWebUI already achieves this functionality. Thus, the main use case of the HistoryServer is in other deploy modes (e.g. Yarn or Mesos).

The logging directory structure is as follows: Within the given base directory, each application's event logs are maintained in the application's own sub-directory. This is the same structure as maintained in the event log write code path in EventLoggingListener.

Linear Supertypes
UIRoot, WebUI, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HistoryServer
  2. UIRoot
  3. WebUI
  4. Logging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HistoryServer(conf: SparkConf, provider: ApplicationHistoryProvider, securityManager: SecurityManager, port: Int)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addStaticHandler(resourceBase: String, path: String): Unit

    Permalink

    Add a handler for static content.

    Add a handler for static content.

    resourceBase

    Root of where to find resources to serve.

    path

    Path in UI where to mount the resources.

    Definition Classes
    WebUI
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def attachHandler(handler: ServletContextHandler): Unit

    Permalink

    Attach a handler to this UI.

    Attach a handler to this UI.

    Definition Classes
    WebUI
  7. def attachPage(page: WebUIPage): Unit

    Permalink

    Attach a page to this UI.

    Attach a page to this UI.

    Definition Classes
    WebUI
  8. def attachTab(tab: WebUITab): Unit

    Permalink

    Attach a tab to this UI, along with all of its attached pages.

    Attach a tab to this UI, along with all of its attached pages.

    Definition Classes
    WebUI
  9. def bind(): Unit

    Permalink

    Bind to the HTTP server behind this web interface.

    Bind to the HTTP server behind this web interface.

    Definition Classes
    HistoryServer → WebUI
  10. def boundPort: Int

    Permalink

    Return the actual port to which this server is bound.

    Return the actual port to which this server is bound. Only valid after bind().

    Definition Classes
    WebUI
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def detachHandler(handler: ServletContextHandler): Unit

    Permalink

    Detach a handler from this UI.

    Detach a handler from this UI.

    Definition Classes
    WebUI
  13. def detachPage(page: WebUIPage): Unit

    Permalink
    Definition Classes
    WebUI
  14. def detachTab(tab: WebUITab): Unit

    Permalink
    Definition Classes
    WebUI
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getApplicationInfoList: Iterator[ApplicationInfo]

    Permalink
    Definition Classes
    HistoryServer → UIRoot
  19. def getApplicationList(): Iterable[ApplicationHistoryInfo]

    Permalink

    Returns a list of available applications, in descending order according to their end time.

    Returns a list of available applications, in descending order according to their end time.

    returns

    List of all known applications.

  20. def getBasePath: String

    Permalink
    Definition Classes
    WebUI
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. def getHandlers: Seq[ServletContextHandler]

    Permalink
    Definition Classes
    WebUI
  23. def getProviderConfig(): Map[String, String]

    Permalink

    Returns the provider configuration to show in the listing page.

    Returns the provider configuration to show in the listing page.

    returns

    A map with the provider's configuration.

  24. def getSecurityManager: SecurityManager

    Permalink
    Definition Classes
    WebUI
  25. def getSparkUI(appKey: String): Option[SparkUI]

    Permalink
    Definition Classes
    HistoryServer → UIRoot
  26. def getTabs: Seq[WebUITab]

    Permalink
    Definition Classes
    WebUI
  27. val handlers: ArrayBuffer[ServletContextHandler]

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. def initialize(): Unit

    Permalink

    Initialize the history server.

    Initialize the history server.

    This starts a background thread that periodically synchronizes information displayed on this UI with the event logs in the provided base directory.

    Definition Classes
    HistoryServer → WebUI
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. val localHostName: String

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  33. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  36. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  38. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  43. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  46. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  48. val pageToHandlers: HashMap[WebUIPage, ArrayBuffer[ServletContextHandler]]

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  49. val publicHostName: String

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  50. def removeStaticHandler(path: String): Unit

    Permalink

    Remove a static content handler.

    Remove a static content handler.

    path

    Path in UI to unmount.

    Definition Classes
    WebUI
  51. val securityManager: SecurityManager

    Permalink
    Definition Classes
    WebUI
  52. var serverInfo: Option[ServerInfo]

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  53. def stop(): Unit

    Permalink

    Stop the server and close the file system.

    Stop the server and close the file system.

    Definition Classes
    HistoryServer → WebUI
  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  55. val tabs: ArrayBuffer[WebUITab]

    Permalink
    Attributes
    protected
    Definition Classes
    WebUI
  56. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def withSparkUI[T](appId: String, attemptId: Option[String])(f: (SparkUI) ⇒ T): T

    Permalink

    Get the spark UI with the given appID, and apply a function to it.

    Get the spark UI with the given appID, and apply a function to it. If there is no such app, throw an appropriate exception

    Definition Classes
    UIRoot
  61. def writeEventLogs(appId: String, attemptId: Option[String], zipStream: ZipOutputStream): Unit

    Permalink

    Write the event logs for the given app to the ZipOutputStream instance.

    Write the event logs for the given app to the ZipOutputStream instance. If attemptId is None, event logs for all attempts of this application will be written out.

    Definition Classes
    HistoryServer → UIRoot

Inherited from UIRoot

Inherited from WebUI

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped