You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2018/02/16 13:42:54 UTC

[3/3] flink git commit: [FLINK-8475][config][docs] Integrate HeartbeatManager options

[FLINK-8475][config][docs] Integrate HeartbeatManager options

This closes #5507.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/ebfa0bdf
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/ebfa0bdf
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/ebfa0bdf

Branch: refs/heads/master
Commit: ebfa0bdf52798cb63c3d6236ac18b7ef1ea7406d
Parents: 8bb9aa4
Author: zentol <ch...@apache.org>
Authored: Tue Jan 23 14:48:24 2018 +0100
Committer: zentol <ch...@apache.org>
Committed: Fri Feb 16 14:42:21 2018 +0100

----------------------------------------------------------------------
 .../heartbeat_manager_configuration.html        | 21 ++++++++++++++++++++
 docs/ops/config.md                              |  4 ++++
 .../configuration/HeartbeatManagerOptions.java  |  6 ++++--
 3 files changed, 29 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/ebfa0bdf/docs/_includes/generated/heartbeat_manager_configuration.html
----------------------------------------------------------------------
diff --git a/docs/_includes/generated/heartbeat_manager_configuration.html b/docs/_includes/generated/heartbeat_manager_configuration.html
new file mode 100644
index 0000000..02e64ad
--- /dev/null
+++ b/docs/_includes/generated/heartbeat_manager_configuration.html
@@ -0,0 +1,21 @@
+<table class="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: 65%">Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><h5>heartbeat.interval</h5></td>
+            <td style="word-wrap: break-word;">10000</td>
+            <td>Time interval for requesting heartbeat from sender side.</td>
+        </tr>
+        <tr>
+            <td><h5>heartbeat.timeout</h5></td>
+            <td style="word-wrap: break-word;">50000</td>
+            <td>Timeout for requesting and receiving heartbeat for both sender and receiver sides.</td>
+        </tr>
+    </tbody>
+</table>

http://git-wip-us.apache.org/repos/asf/flink/blob/ebfa0bdf/docs/ops/config.md
----------------------------------------------------------------------
diff --git a/docs/ops/config.md b/docs/ops/config.md
index 050a616..efd3ee3 100644
--- a/docs/ops/config.md
+++ b/docs/ops/config.md
@@ -286,6 +286,10 @@ These parameters configure the default HDFS used by Flink. Setups that do not sp
 
 {% include generated/blob_server_configuration.html %}
 
+### Heartbeat Manager
+
+{% include generated/heartbeat_manager_configuration.html %}
+
 ### SSL Settings
 
 {% include generated/security_configuration.html %}

http://git-wip-us.apache.org/repos/asf/flink/blob/ebfa0bdf/flink-core/src/main/java/org/apache/flink/configuration/HeartbeatManagerOptions.java
----------------------------------------------------------------------
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/HeartbeatManagerOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/HeartbeatManagerOptions.java
index e2f6ff6..0fe4341 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/HeartbeatManagerOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/HeartbeatManagerOptions.java
@@ -31,12 +31,14 @@ public class HeartbeatManagerOptions {
 	/** Time interval for requesting heartbeat from sender side. */
 	public static final ConfigOption<Long> HEARTBEAT_INTERVAL =
 			key("heartbeat.interval")
-			.defaultValue(10000L);
+			.defaultValue(10000L)
+			.withDescription("Time interval for requesting heartbeat from sender side.");
 
 	/** Timeout for requesting and receiving heartbeat for both sender and receiver sides. */
 	public static final ConfigOption<Long> HEARTBEAT_TIMEOUT =
 			key("heartbeat.timeout")
-			.defaultValue(50000L);
+			.defaultValue(50000L)
+			.withDescription("Timeout for requesting and receiving heartbeat for both sender and receiver sides.");
 
 	// ------------------------------------------------------------------------