| <table class="configuration table table-bordered"> |
| <thead> |
| <tr> |
| <th class="text-left" style="width: 20%">Key</th> |
| <th class="text-left" style="width: 15%">Default</th> |
| <th class="text-left" style="width: 10%">Type</th> |
| <th class="text-left" style="width: 55%">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><h5>historyserver.archive.clean-expired-jobs</h5></td> |
| <td style="word-wrap: break-word;">false</td> |
| <td>Boolean</td> |
| <td>Whether HistoryServer should cleanup jobs that are no longer present `historyserver.archive.fs.dir`.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.archive.fs.dir</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>String</td> |
| <td>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`.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.archive.fs.refresh-interval</h5></td> |
| <td style="word-wrap: break-word;">10 s</td> |
| <td>Duration</td> |
| <td>Interval for refreshing the archived job directories.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.archive.retained-jobs</h5></td> |
| <td style="word-wrap: break-word;">-1</td> |
| <td>Integer</td> |
| <td>The maximum number of jobs to retain in each archive directory defined by <code class="highlighter-rouge">historyserver.archive.fs.dir</code>. <ul><li>If the option is not specified as a positive number without specifying <code class="highlighter-rouge">historyserver.archive.retained-ttl</code>, all of the jobs archives will be retained. </li><li>If the option is specified as a positive number without specifying a value of <code class="highlighter-rouge">historyserver.archive.retained-ttl</code>, the jobs archive whose order index based modification time is equals to or less than the value will be retained. </li><li>If this option is specified as a positive number together with the specified <code class="highlighter-rouge">historyserver.archive.retained-ttl</code> option, the job archive will be removed if its TTL has expired or the retained job count has been reached. </li></ul>If set to <code class="highlighter-rouge">0</code> or less than <code class="highlighter-rouge">-1</code>, HistoryServer will throw an <code class="highlighter-rouge">IllegalConfigurationException</code>. <br />Note, when there are multiple history server instances, two recommended approaches when using this option are: <ul><li>Specify the option in only one HistoryServer instance to avoid errors caused by multiple instances simultaneously cleaning up remote files, </li><li>Or you can keep the value of this configuration consistent across them. </li></ul></td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.archive.retained-ttl</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>Duration</td> |
| <td>The time-to-live duration to retain the jobs archived in each archive directory defined by <code class="highlighter-rouge">historyserver.archive.fs.dir</code>. <ul><li>If the option is not specified without specifying <code class="highlighter-rouge">historyserver.archive.retained-jobs</code>, all of the jobs archives will be retained. </li><li>If the option is specified without specifying <code class="highlighter-rouge">historyserver.archive.retained-jobs</code>, the jobs archive whose modification time in the time-to-live duration will be retained. </li><li>If this option is specified as a positive time duration together with the <code class="highlighter-rouge">historyserver.archive.retained-jobs</code> option, the job archive will be removed if its TTL has expired or the retained job count has been reached. </li></ul>If set to equal to or less than <code class="highlighter-rouge">0</code> milliseconds, HistoryServer will throw an <code class="highlighter-rouge">IllegalConfigurationException</code>. <br />Note, when there are multiple history server instances, two recommended approaches when using this option are: <ul><li>Specify the option in only one HistoryServer instance to avoid errors caused by multiple instances simultaneously cleaning up remote files, </li><li>Or you can keep the value of this configuration consistent across them. </li></ul></td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.log.jobmanager.url-pattern</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>String</td> |
| <td>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.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.log.taskmanager.url-pattern</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>String</td> |
| <td>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.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.web.address</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>String</td> |
| <td>Address of the HistoryServer's web interface.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.web.port</h5></td> |
| <td style="word-wrap: break-word;">8082</td> |
| <td>Integer</td> |
| <td>Port of the HistoryServers's web interface.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.web.refresh-interval</h5></td> |
| <td style="word-wrap: break-word;">10 s</td> |
| <td>Duration</td> |
| <td>The refresh interval for the HistoryServer web-frontend.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.web.ssl.enabled</h5></td> |
| <td style="word-wrap: break-word;">false</td> |
| <td>Boolean</td> |
| <td>Enable HTTPs access to the HistoryServer web frontend. This is applicable only when the global SSL flag security.ssl.enabled is set to true.</td> |
| </tr> |
| <tr> |
| <td><h5>historyserver.web.tmpdir</h5></td> |
| <td style="word-wrap: break-word;">(none)</td> |
| <td>String</td> |
| <td>Local directory that is used by the history server REST API for temporary files.</td> |
| </tr> |
| </tbody> |
| </table> |
