This is an automated email from the ASF dual-hosted git repository.
zhijiang pushed a commit to branch release-1.10
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 46338c6df09d4cd78f1626a6cc0f17b869b6c629
Author: kevin.cyj <kevin....@alibaba-inc.com>
AuthorDate: Thu Dec 12 15:52:13 2019 +0800
[hotfix][config] Document enhancement: reminding users that shuffle data
compression is experimental currently
---
.../generated/netty_shuffle_environment_configuration.html | 4 ++--
.../configuration/NettyShuffleEnvironmentOptions.java | 14 +++++++++-----
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git
a/docs/_includes/generated/netty_shuffle_environment_configuration.html
b/docs/_includes/generated/netty_shuffle_environment_configuration.html
index b94fa1b..5eb65cc 100644
--- a/docs/_includes/generated/netty_shuffle_environment_configuration.html
+++ b/docs/_includes/generated/netty_shuffle_environment_configuration.html
@@ -24,7 +24,7 @@
<td><h5>taskmanager.network.blocking-shuffle.compression.enabled</h5></td>
<td style="word-wrap: break-word;">false</td>
<td>Boolean</td>
- <td>Boolean flag indicating whether the shuffle data will be
compressed for blocking shuffle mode. Note that data is compressed per buffer
and compression can incur extra CPU overhead, so it is more effective for IO
bounded scenario when data compression ratio is high.</td>
+ <td>Boolean flag indicating whether the shuffle data will be
compressed for blocking shuffle mode. Note that data is compressed per buffer
and compression can incur extra CPU overhead, so it is more effective for IO
bounded scenario when data compression ratio is high. Currently, shuffle data
compression is an experimental feature and the config option can be changed in
the future.</td>
</tr>
<tr>
<td><h5>taskmanager.network.blocking-shuffle.type</h5></td>
@@ -54,7 +54,7 @@
<td><h5>taskmanager.network.pipelined-shuffle.compression.enabled</h5></td>
<td style="word-wrap: break-word;">false</td>
<td>Boolean</td>
- <td>Boolean flag indicating whether the shuffle data will be
compressed for pipelined shuffle mode. Note that data is compressed per sliced
buffer and compression can incur extra CPU overhead, so it is not recommended
to enable compression if network is not the bottleneck or compression ratio is
low.</td>
+ <td>Boolean flag indicating whether the shuffle data will be
compressed for pipelined shuffle mode. Note that data is compressed per sliced
buffer and compression is disabled for operators using broadcast partitioner.
Because of the extra CPU overhead, it is not recommended to enable compression
if network is not the bottleneck or compression ratio is low. Currently,
shuffle data compression is an experimental feature and the config option can
be changed in the future.</td>
</tr>
<tr>
<td><h5>taskmanager.network.request-backoff.initial</h5></td>
diff --git
a/flink-core/src/main/java/org/apache/flink/configuration/NettyShuffleEnvironmentOptions.java
b/flink-core/src/main/java/org/apache/flink/configuration/NettyShuffleEnvironmentOptions.java
index 561d5e9..2aa5d4b 100644
---
a/flink-core/src/main/java/org/apache/flink/configuration/NettyShuffleEnvironmentOptions.java
+++
b/flink-core/src/main/java/org/apache/flink/configuration/NettyShuffleEnvironmentOptions.java
@@ -57,22 +57,25 @@ public class NettyShuffleEnvironmentOptions {
/**
* Boolean flag indicating whether the shuffle data will be compressed
for blocking shuffle mode.
*
- * <p>Note: Data is compressed per buffer and compression can incur
extra CPU overhead so it is more effective for IO
- * bounded scenario when data compression ratio is high.
+ * <p>Note: Data is compressed per buffer and compression can incur
extra CPU overhead so it is more effective for
+ * IO bounded scenario when data compression ratio is high. Currently,
shuffle data compression is an experimental
+ * feature and the config option can be changed in the future.
*/
public static final ConfigOption<Boolean>
BLOCKING_SHUFFLE_COMPRESSION_ENABLED =
key("taskmanager.network.blocking-shuffle.compression.enabled")
.defaultValue(false)
.withDescription("Boolean flag indicating whether the
shuffle data will be compressed for blocking shuffle" +
" mode. Note that data is compressed per buffer
and compression can incur extra CPU overhead, so it is" +
- " more effective for IO bounded scenario when
data compression ratio is high.");
+ " more effective for IO bounded scenario when
data compression ratio is high. Currently, shuffle data " +
+ "compression is an experimental feature and the
config option can be changed in the future.");
/**
* Boolean flag indicating whether the shuffle data will be compressed
for pipelined shuffle mode.
*
* <p>Note: Data is compressed per sliced buffer and compression is
disabled for operators using broadcast partitioner.
* Because of the extra CPU overhead, it is not recommended to enable
compression if network is not the bottleneck or
- * compression ratio is low.
+ * compression ratio is low. Currently, shuffle data compression is an
experimental feature and the config option can
+ * be changed in the future.
*/
public static final ConfigOption<Boolean>
PIPELINED_SHUFFLE_COMPRESSION_ENABLED =
key("taskmanager.network.pipelined-shuffle.compression.enabled")
@@ -80,7 +83,8 @@ public class NettyShuffleEnvironmentOptions {
.withDescription("Boolean flag indicating whether the
shuffle data will be compressed for pipelined shuffle" +
" mode. Note that data is compressed per sliced
buffer and compression is disabled for operators using " +
"broadcast partitioner. Because of the extra
CPU overhead, it is not recommended to enable compression " +
- "if network is not the bottleneck or
compression ratio is low.");
+ "if network is not the bottleneck or
compression ratio is low. Currently, shuffle data compression is " +
+ "an experimental feature and the config option
can be changed in the future.");
/**
* The codec to be used when compressing shuffle data.
