Package org.apache.flink.runtime.webmonitor.history

Class HistoryServer

java.lang.Object
org.apache.flink.runtime.webmonitor.history.HistoryServer
public class HistoryServer extends Object
The HistoryServer provides a WebInterface and REST API to retrieve information about finished jobs for which the JobManager may have already shut down.

The HistoryServer regularly checks a set of directories for job archives created by the FsJobArchivist and caches these in a local directory. See HistoryServerArchiveFetcher.

All configuration options are defined inHistoryServerOptions.

The WebInterface only displays the "Completed Jobs" page.

The REST API is limited to

  • /config
  • /joboverview
  • /jobs/:jobid/*

and relies on static files that are served by the HistoryServerStaticFileServerHandler.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HistoryServer(org.apache.flink.configuration.Configuration config)
     
    HistoryServer(org.apache.flink.configuration.Configuration config, Consumer<org.apache.flink.runtime.webmonitor.history.HistoryServerArchiveFetcher.ArchiveEvent> jobArchiveEventListener)
    Creates HistoryServer instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    main(String[] args)
     
    void
    run()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • HistoryServer

      public HistoryServer(org.apache.flink.configuration.Configuration config) throws IOException, org.apache.flink.util.FlinkException
      Throws:
      IOException
      org.apache.flink.util.FlinkException

    • HistoryServer

      public HistoryServer(org.apache.flink.configuration.Configuration config, Consumer<org.apache.flink.runtime.webmonitor.history.HistoryServerArchiveFetcher.ArchiveEvent> jobArchiveEventListener) throws IOException, org.apache.flink.util.FlinkException
      Creates HistoryServer instance.
      Parameters:
      config - configuration
      jobArchiveEventListener - Listener for job archive operations. First param is operation, second param is id of the job.
      Throws:
      IOException - When creation of SSL factory failed
      org.apache.flink.util.FlinkException - When configuration error occurred

  • Method Details