Key Default Type Description
historyserver.archive.clean-expired-applications
false Boolean Whether HistoryServer should cleanup applications that are no longer present in the archive directory defined by historyserver.archive.fs.dir.
historyserver.archive.clean-expired-jobs
false Boolean Whether HistoryServer should cleanup jobs that are no longer present in the archive directory defined by historyserver.archive.fs.dir.
Note: This option applies only to legacy job archives created before the introduction of application archiving (FLINK-38761).
historyserver.archive.fs.dir
(none) String Comma separated list of directories to fetch archived jobs from. The history server will monitor these directories for archived jobs. You can configure the JobManager to archive jobs to a directory via `jobmanager.archive.fs.dir`.
historyserver.archive.fs.refresh-interval
10 s Duration Interval for refreshing the archived job directories.
historyserver.archive.retained-applications
-1 Integer The maximum number of applications to retain in each archive directory defined by historyserver.archive.fs.dir. This option works together with the TTL (see historyserver.archive.retained-ttl). Archived entities will be removed if their TTL has expired or the retention count limit has been reached.
If set to -1 (default), there is no limit to the number of archives. If set to 0 or less than -1, HistoryServer will throw an IllegalConfigurationException.
Note, when there are multiple history server instances, two recommended approaches when using this option are:
  • Specify the option in only one HistoryServer instance to avoid errors caused by multiple instances simultaneously cleaning up remote files,
  • Or you can keep the value of this configuration consistent across them.
historyserver.archive.retained-jobs
-1 Integer The maximum number of jobs to retain in each archive directory defined by historyserver.archive.fs.dir.
  • If the option is not specified as a positive number without specifying historyserver.archive.retained-ttl, all of the jobs archives will be retained.
  • If the option is specified as a positive number without specifying a value of historyserver.archive.retained-ttl, the jobs archive whose order index based modification time is equals to or less than the value will be retained.
  • If this option is specified as a positive number together with the specified historyserver.archive.retained-ttl option, the job archive will be removed if its TTL has expired or the retained job count has been reached.
If set to 0 or less than -1, HistoryServer will throw an IllegalConfigurationException.
Note, when there are multiple history server instances, two recommended approaches when using this option are:
  • Specify the option in only one HistoryServer instance to avoid errors caused by multiple instances simultaneously cleaning up remote files,
  • Or you can keep the value of this configuration consistent across them.

Note: This option applies only to legacy job archives created before the introduction of application archiving (FLINK-38761).
historyserver.archive.retained-ttl
(none) Duration The time-to-live duration to retain the archived entities (jobs and applications) in each archive directory defined by historyserver.archive.fs.dir. This option works together with the retention count limits (see historyserver.archive.retained-applications and historyserver.archive.retained-jobs). Archived entities will be removed if their TTL has expired or the retention count limit has been reached.
If set to equal to or less than 0 milliseconds, HistoryServer will throw an IllegalConfigurationException.
Note, when there are multiple history server instances, two recommended approaches when using this option are:
  • Specify the option in only one HistoryServer instance to avoid errors caused by multiple instances simultaneously cleaning up remote files,
  • Or you can keep the value of this configuration consistent across them.
historyserver.log.jobmanager.url-pattern
(none) String Pattern of the log URL of JobManager. The HistoryServer will generate actual URLs from it, with replacing the special placeholders, `<jobid>`, to the id of job. Only http / https schemes are supported.
historyserver.log.taskmanager.url-pattern
(none) String Pattern of the log URL of TaskManager. The HistoryServer will generate actual URLs from it, with replacing the special placeholders, `<jobid>` and `<tmid>`, to the id of job and TaskManager respectively. Only http / https schemes are supported.
historyserver.web.address
(none) String Address of the HistoryServer's web interface.
historyserver.web.port
8082 Integer Port of the HistoryServers's web interface.
historyserver.web.refresh-interval
10 s Duration The refresh interval for the HistoryServer web-frontend.
historyserver.web.ssl.enabled
false Boolean Enable HTTPs access to the HistoryServer web frontend. This is applicable only when the global SSL flag security.ssl.enabled is set to true.
historyserver.web.tmpdir
(none) String Local directory that is used by the history server REST API for temporary files.