This is an automated email from the ASF dual-hosted git repository. xtsong pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit b25b921b87c0652e73e16a489bc2817f0cbfa1ba Author: sxnan <[email protected]> AuthorDate: Tue May 28 09:25:49 2024 +0800 [FLINK-35461][config] Deprecate netty options that are not recommended to be used --- .../generated/all_taskmanager_network_section.html | 36 ---------------------- .../netty_shuffle_environment_configuration.html | 36 ---------------------- .../NettyShuffleEnvironmentOptions.java | 36 ++++++++++++++++++---- 3 files changed, 30 insertions(+), 78 deletions(-) diff --git a/docs/layouts/shortcodes/generated/all_taskmanager_network_section.html b/docs/layouts/shortcodes/generated/all_taskmanager_network_section.html index 46090128563..57103c7cbcb 100644 --- a/docs/layouts/shortcodes/generated/all_taskmanager_network_section.html +++ b/docs/layouts/shortcodes/generated/all_taskmanager_network_section.html @@ -80,12 +80,6 @@ <td>Integer</td> <td>The Netty client connection timeout.</td> </tr> - <tr> - <td><h5>taskmanager.network.netty.client.numThreads</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty client threads.</td> - </tr> <tr> <td><h5>taskmanager.network.netty.client.tcp.keepCount</h5></td> <td style="word-wrap: break-word;">(none)</td> @@ -104,36 +98,6 @@ <td>Integer</td> <td>The time (in seconds) between individual keepalive probes. Note: This will not take effect when using netty transport type of nio with an older version of JDK 8, refer to https://bugs.openjdk.org/browse/JDK-8194298.</td> </tr> - <tr> - <td><h5>taskmanager.network.netty.num-arenas</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty arenas.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.sendReceiveBufferSize</h5></td> - <td style="word-wrap: break-word;">0</td> - <td>Integer</td> - <td>The Netty send and receive buffer size. This defaults to the system buffer size (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.server.backlog</h5></td> - <td style="word-wrap: break-word;">0</td> - <td>Integer</td> - <td>The netty server connection backlog.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.server.numThreads</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty server threads.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.transport</h5></td> - <td style="word-wrap: break-word;">"auto"</td> - <td>String</td> - <td>The Netty transport type, either "nio" or "epoll". The "auto" means selecting the property mode automatically based on the platform. Note that the "epoll" mode can get better performance, less GC and have more advanced features which are only available on modern Linux.</td> - </tr> <tr> <td><h5>taskmanager.network.partition-request-timeout</h5></td> <td style="word-wrap: break-word;">10 s</td> diff --git a/docs/layouts/shortcodes/generated/netty_shuffle_environment_configuration.html b/docs/layouts/shortcodes/generated/netty_shuffle_environment_configuration.html index e9446edc23a..9a81bb09013 100644 --- a/docs/layouts/shortcodes/generated/netty_shuffle_environment_configuration.html +++ b/docs/layouts/shortcodes/generated/netty_shuffle_environment_configuration.html @@ -68,12 +68,6 @@ <td>Integer</td> <td>The Netty client connection timeout.</td> </tr> - <tr> - <td><h5>taskmanager.network.netty.client.numThreads</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty client threads.</td> - </tr> <tr> <td><h5>taskmanager.network.netty.client.tcp.keepCount</h5></td> <td style="word-wrap: break-word;">(none)</td> @@ -92,36 +86,6 @@ <td>Integer</td> <td>The time (in seconds) between individual keepalive probes. Note: This will not take effect when using netty transport type of nio with an older version of JDK 8, refer to https://bugs.openjdk.org/browse/JDK-8194298.</td> </tr> - <tr> - <td><h5>taskmanager.network.netty.num-arenas</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty arenas.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.sendReceiveBufferSize</h5></td> - <td style="word-wrap: break-word;">0</td> - <td>Integer</td> - <td>The Netty send and receive buffer size. This defaults to the system buffer size (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.server.backlog</h5></td> - <td style="word-wrap: break-word;">0</td> - <td>Integer</td> - <td>The netty server connection backlog.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.server.numThreads</h5></td> - <td style="word-wrap: break-word;">-1</td> - <td>Integer</td> - <td>The number of Netty server threads.</td> - </tr> - <tr> - <td><h5>taskmanager.network.netty.transport</h5></td> - <td style="word-wrap: break-word;">"auto"</td> - <td>String</td> - <td>The Netty transport type, either "nio" or "epoll". The "auto" means selecting the property mode automatically based on the platform. Note that the "epoll" mode can get better performance, less GC and have more advanced features which are only available on modern Linux.</td> - </tr> <tr> <td><h5>taskmanager.network.partition-request-timeout</h5></td> <td style="word-wrap: break-word;">10 s</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 af08b80a3ad..a0ea6036d91 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 @@ -560,7 +560,11 @@ public class NettyShuffleEnvironmentOptions { // Netty Options // ------------------------------------------------------------------------ - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<Integer> NUM_ARENAS = key("taskmanager.network.netty.num-arenas") .intType() @@ -568,7 +572,11 @@ public class NettyShuffleEnvironmentOptions { .withDeprecatedKeys("taskmanager.net.num-arenas") .withDescription("The number of Netty arenas."); - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<Integer> NUM_THREADS_SERVER = key("taskmanager.network.netty.server.numThreads") .intType() @@ -576,7 +584,11 @@ public class NettyShuffleEnvironmentOptions { .withDeprecatedKeys("taskmanager.net.server.numThreads") .withDescription("The number of Netty server threads."); - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<Integer> NUM_THREADS_CLIENT = key("taskmanager.network.netty.client.numThreads") .intType() @@ -584,7 +596,11 @@ public class NettyShuffleEnvironmentOptions { .withDeprecatedKeys("taskmanager.net.client.numThreads") .withDescription("The number of Netty client threads."); - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<Integer> CONNECT_BACKLOG = key("taskmanager.network.netty.server.backlog") .intType() @@ -610,7 +626,11 @@ public class NettyShuffleEnvironmentOptions { "The number of retry attempts for network communication." + " Currently it's only used for establishing input/output channel connections"); - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<Integer> SEND_RECEIVE_BUFFER_SIZE = key("taskmanager.network.netty.sendReceiveBufferSize") .intType() @@ -620,7 +640,11 @@ public class NettyShuffleEnvironmentOptions { "The Netty send and receive buffer size. This defaults to the system buffer size" + " (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux."); - @Documentation.Section(Documentation.Sections.ALL_TASK_MANAGER_NETWORK) + /** + * @deprecated It is not recommended to use the option. It is deprecated in 1.20 and will be + * totally removed in 2.0. + */ + @Deprecated public static final ConfigOption<String> TRANSPORT_TYPE = key("taskmanager.network.netty.transport") .stringType()
