You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by xi...@apache.org on 2022/06/06 14:07:58 UTC

[incubator-shenyu-website] branch main updated: [type:optimize] update netty http parameters (#589)

This is an automated email from the ASF dual-hosted git repository.

xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git


The following commit(s) were added to refs/heads/main by this push:
     new b90e17217e [type:optimize] update netty http parameters (#589)
b90e17217e is described below

commit b90e17217e60d70fead96d59b0092fbfb217af6d
Author: moremind <he...@hotmail.com>
AuthorDate: Mon Jun 6 22:07:54 2022 +0800

    [type:optimize] update netty http parameters (#589)
---
 .../property-config/gateway-property-config.md     | 76 ++++++++++++----------
 .../property-config/gateway-property-config.md     | 76 ++++++++++++----------
 2 files changed, 86 insertions(+), 66 deletions(-)

diff --git a/docs/user-guide/property-config/gateway-property-config.md b/docs/user-guide/property-config/gateway-property-config.md
index 7f1aaedebb..7c300474c4 100644
--- a/docs/user-guide/property-config/gateway-property-config.md
+++ b/docs/user-guide/property-config/gateway-property-config.md
@@ -13,10 +13,11 @@ This paper mainly explains how to configure `Apache ShenYu` properties on the ga
 ```yaml
 shenyu:
   netty:
-    tcp:
+    http:
       webServerFactoryEnabled: true
       selectCount: 1
       workerCount: 4
+      accessLog: false
       serverSocketChannel:
         soRcvBuf: 87380
         soBackLog: 128
@@ -25,8 +26,10 @@ shenyu:
         writeBufferHighWaterMark: 65536
         writeBufferLowWaterMark: 32768
         writeSpinCount: 16
-        autoRead: true
+        autoRead: false
         allocType: "pooled"
+        messageSizeEstimator: 8
+        singleEventExecutorPerGroup: true
       socketChannel:
         soKeepAlive: false
         soReuseAddr: false
@@ -40,8 +43,10 @@ shenyu:
         writeBufferHighWaterMark: 65536
         writeBufferLowWaterMark: 32768
         writeSpinCount: 16
-        autoRead: true
+        autoRead: false
         allocType: "pooled"
+        messageSizeEstimator: 8
+        singleEventExecutorPerGroup: true
   instance:
     enabled: false
     registerType: zookeeper #etcd #consul
@@ -151,36 +156,41 @@ shenyu:
 
 `ShenYu` Netty config
 
-|Name                      | Type  |  Default   | Required  | Description                        |
-|:------------------------ |:----- |:-------: |:-------:|:----------------------------|
-|webServerFactoryEnabled | Boolean | true | No | Whether to enable custom parameters. True-enable. False-NettyReactiveWebServerFactory Can be configured by yourself. |
-| selectCount | Integer |  1  |    No    | Number of netty selectors. |
-| workerCount | Integer | 4 | No | Number of netty workers. |
-| **ServerSocketChannelConfig** |  |  |  |  |
-| soRcvBuf                      | Integer |  87380  |    No    | Socket config, the size of the socket receive buffer.        |
-| soBackLog                     | Integer |   128   |    No    | Socket config, maximum length of the accept queue.           |
-| soReuseAddr                   | Boolean |  false  |    No    | Socket config, allow reuse of local addresses.               |
-| connectTimeoutMillis          | Integer |  10000  |    No    | Netty config, the connect timeout of the channel in milliseconds. |
-| writeBufferHighWaterMark      | Integer |  65536  |    No    | Netty config, the high water mark of the write buffer.       |
-| writeBufferLowWaterMark       | Integer |  32768  |    No    | Netty config, the low water mark of the write buffer.        |
-| writeSpinCount | Integer | 16 | No | Netty config, the maximum loop count for a write operation. |
-| autoRead | Boolean | true | No | Netty config,  channel read method will be invoked automatically so that a user application doesn't need to call it at all. |
-| allocType                     | String  | pooled  |    No    | Netty config, set the ByteBufAllocator which is used for the channel to allocate buffers. |
-| **SocketChannelConfig** |  |  |  |  |
-| soKeepAlive | Boolean | false | No | Socket config, enable tcp keepalive. |
-| soReuseAddr | Boolean | false | No | Socket config, allow reuse of local addresses. |
-| soLinger | Integer | -1 | No | Socket config, the delay time for closing the socket. |
-| tcpNoDelay | Boolean | true | No | Socket config, enable Nagle algorithm. |
-| soRcvBuf | Integer | 87380 | No | Socket config, the size of the socket receive buffer. |
-| soSndBuf | Integer | 128 | No | Socket config, the size of the socket send buffer. |
-| ipTos | Integer | 0 | No | IP config, the Type of Service (ToS) octet in the Internet Protocol (IP) header. |
-| allowHalfClosure | Boolean | false | No | Netty config, Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. |
-| connectTimeoutMillis | Integer | 10000 | No | Netty config, the connect timeout of the channel in milliseconds. |
-| writeBufferHighWaterMark | Integer | 65536 | No | Netty config, the high water mark of the write buffer. |
-| writeBufferLowWaterMark | Integer | 32768 | No | Netty config, the low water mark of the write buffer. |
-| writeSpinCount | Integer | 16 | No | Netty config, the maximum loop count for a write operation. |
-| autoRead | Boolean | true | No | Netty config,  channel read method will be invoked automatically so that a user application doesn't need to call it at all. |
-| allocType | String | pooled | No | Netty config, set the ByteBufAllocator which is used for the channel to allocate buffers. |
+| Name                          | Type    | Default | Required | Description                                                                                                                               |
+|:------------------------------|:--------|:-------:|:--------:|:------------------------------------------------------------------------------------------------------------------------------------------|
+| webServerFactoryEnabled       | Boolean |  true   |    No    | Whether to enable custom parameters. True-enable. False-NettyReactiveWebServerFactory Can be configured by yourself.                      |
+| selectCount                   | Integer |    1    |    No    | Number of netty selectors.                                                                                                                |
+| workerCount                   | Integer |    4    |    No    | Number of netty workers.                                                                                                                  |
+| accessLog                     | Boolean |  false  |    No    | netty request parameters.                                                                                                                 |
+| **ServerSocketChannelConfig** |         |         |          |                                                                                                                                           |
+| soRcvBuf                      | Integer |  87380  |    No    | Socket config, the size of the socket receive buffer.                                                                                     |
+| soBackLog                     | Integer |   128   |    No    | Socket config, maximum length of the accept queue.                                                                                        |
+| soReuseAddr                   | Boolean |  false  |    No    | Socket config, allow reuse of local addresses.                                                                                            |
+| connectTimeoutMillis          | Integer |  10000  |    No    | Netty config, the connect timeout of the channel in milliseconds.                                                                         |
+| writeBufferHighWaterMark      | Integer |  65536  |    No    | Netty config, the high water mark of the write buffer.                                                                                    |
+| writeBufferLowWaterMark       | Integer |  32768  |    No    | Netty config, the low water mark of the write buffer.                                                                                     |
+| writeSpinCount                | Integer |   16    |    No    | Netty config, the maximum loop count for a write operation.                                                                               |
+| autoRead                      | Boolean |  true   |    No    | Netty config,  channel read method will be invoked automatically so that a user application doesn't need to call it at all.               |
+| allocType                     | String  | pooled  |    No    | Netty config, set the ByteBufAllocator which is used for the channel to allocate buffers.                                                 |
+| messageSizeEstimator          | Integer |    8    |    No    | Netty config, message size estimator, estimate ByteBuf,ByteBufHolder and FileRegion size.                                                 |
+| singleEventExecutorPerGroup   | Boolean |  true   |    No    | Netty config, single thread execute the event of ChannelPipeline.                                                                         |
+| **SocketChannelConfig**       |         |         |          |                                                                                                                                           |
+| soKeepAlive                   | Boolean |  false  |    No    | Socket config, enable tcp keepalive.                                                                                                      |
+| soReuseAddr                   | Boolean |  false  |    No    | Socket config, allow reuse of local addresses.                                                                                            |
+| soLinger                      | Integer |   -1    |    No    | Socket config, the delay time for closing the socket.                                                                                     |
+| tcpNoDelay                    | Boolean |  true   |    No    | Socket config, enable Nagle algorithm.                                                                                                    |
+| soRcvBuf                      | Integer |  87380  |    No    | Socket config, the size of the socket receive buffer.                                                                                     |
+| soSndBuf                      | Integer |   128   |    No    | Socket config, the size of the socket send buffer.                                                                                        |
+| ipTos                         | Integer |    0    |    No    | IP config, the Type of Service (ToS) octet in the Internet Protocol (IP) header.                                                          |
+| allowHalfClosure              | Boolean |  false  |    No    | Netty config, Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. |
+| connectTimeoutMillis          | Integer |  10000  |    No    | Netty config, the connect timeout of the channel in milliseconds.                                                                         |
+| writeBufferHighWaterMark      | Integer |  65536  |    No    | Netty config, the high water mark of the write buffer.                                                                                    |
+| writeBufferLowWaterMark       | Integer |  32768  |    No    | Netty config, the low water mark of the write buffer.                                                                                     |
+| writeSpinCount                | Integer |   16    |    No    | Netty config, the maximum loop count for a write operation.                                                                               |
+| autoRead                      | Boolean |  true   |    No    | Netty config,  channel read method will be invoked automatically so that a user application doesn't need to call it at all.               |
+| allocType                     | String  | pooled  |    No    | Netty config, set the ByteBufAllocator which is used for the channel to allocate buffers.                                                 |
+| messageSizeEstimator          | Integer |    8    |    No    | Netty config, message size estimator, estimate ByteBuf,ByteBufHolder and FileRegion size.                                                 |
+| singleEventExecutorPerGroup   | Boolean |  true   |    No    | Netty config, single thread execute the event of ChannelPipeline.                                                                         |
 
 ##### shenyu.instance config
 
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/gateway-property-config.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/gateway-property-config.md
index 5c8910ef15..bc39d6d5b0 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/gateway-property-config.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/gateway-property-config.md
@@ -13,10 +13,11 @@ description: 网关属性配置
 ```yaml
 shenyu:
   netty:
-    tcp:
+    http:
       webServerFactoryEnabled: true
       selectCount: 1
       workerCount: 4
+      accessLog: false
       serverSocketChannel:
         soRcvBuf: 87380
         soBackLog: 128
@@ -25,8 +26,10 @@ shenyu:
         writeBufferHighWaterMark: 65536
         writeBufferLowWaterMark: 32768
         writeSpinCount: 16
-        autoRead: true
+        autoRead: false
         allocType: "pooled"
+        messageSizeEstimator: 8
+        singleEventExecutorPerGroup: true
       socketChannel:
         soKeepAlive: false
         soReuseAddr: false
@@ -40,8 +43,10 @@ shenyu:
         writeBufferHighWaterMark: 65536
         writeBufferLowWaterMark: 32768
         writeSpinCount: 16
-        autoRead: true
+        autoRead: false
         allocType: "pooled"
+        messageSizeEstimator: 8
+        singleEventExecutorPerGroup: true
   instance:
     enabled: false
     registerType: zookeeper #etcd #consul
@@ -151,36 +156,41 @@ shenyu:
 
 `ShenYu` Netty 配置
 
-|Name                      | Type  |  Default   | Required  | Description                        |
-|:------------------------ |:----- |:-------: |:-------:|:----------------------------|
-|webServerFactoryEnabled | Boolean | true | No | 是否开启自定义参数,true-开启,false-可以自行配置NettyReactiveWebServerFactory |
-| selectCount | Integer |  1  |    No    | Netty 选择器数 |
-| workerCount | Integer | 4 | No | Netty 工作线程数 |
-| **ServerSocketChannelConfig** |  |  |  |  |
-| soRcvBuf              | Integer | 87380 | No | Socket参数,TCP数据接收缓冲区大小 |
-| soBackLog            | Integer | 128 | No | Socket参数,服务端接受连接的队列长度 |
-| soReuseAddr | Boolean | false | No | Socket 参数,是否复用地址 |
-| connectTimeoutMillis | Integer | 10000 | No | Netty 参数,连接超时时间 |
-| writeBufferHighWaterMark | Integer | 65536 | No | Netty 参数,通道水位线上限 |
-| writeBufferLowWaterMark | Integer | 32768 | No | Netty 参数,通道水位线下限 |
-| writeSpinCount                | Integer |   16    |    No    | Netty参数,一个Loop写操作执行的最大次数         |
-| autoRead                      | Boolean |  true   |    No    | Netty参数,自动读取                             |
-| allocType                     | String  | pooled  |    No    | Netty参数,ByteBuf的分配器 |
-| **SocketChannelConfig** |  |  |  |  |
-| soKeepAlive | Boolean | false | No | Socket 参数,是否启用心跳保活机制 |
-| soReuseAddr | Boolean | false | No | Socket 参数,是否复用地址 |
-| soLinger | Integer | -1 | No | Socket 参数,关闭 Socket 的延迟时间 |
-| tcpNoDelay | Boolean | true | No | Socket 参数,是否启用 Nagle 算法 |
-| soRcvBuf | Integer | 87380 | No | Socket参数,TCP数据接收缓冲区大小 |
-| soSndBuf | Integer | 128 | No |  |
-| ipTos | Integer | 0 | No | IP参数,设置IP头部的Type-of-Service字段,用于描述IP包的优先级和QoS选项 |
-| allowHalfClosure | Boolean | false | No | Netty参数,一个连接的远端关闭时本地端是否关闭 |
-| connectTimeoutMillis | Integer | 10000 | No | Netty 参数,连接超时时间 |
-| writeBufferHighWaterMark | Integer | 65536 | No | Netty 参数,通道水位线上限 |
-| writeBufferLowWaterMark | Integer | 32768 | No | Netty 参数,通道水位线下限 |
-| writeSpinCount | Integer | 16 | No | Netty参数,一个Loop写操作执行的最大次数 |
-| autoRead | Boolean | true | No | Netty参数,自动读取 |
-| allocType | String | pooled | No | Netty参数,ByteBuf的分配器 |
+| Name                          | Type  | Default | Required | Description                                                 |
+|:------------------------------|:----- |:-------:|:--------:|:------------------------------------------------------------|
+| webServerFactoryEnabled       | Boolean |  true   |    No    | 是否开启自定义参数,true-开启,false-可以自行配置NettyReactiveWebServerFactory |
+| selectCount                   | Integer |    1    |    No    | Netty 选择器数                                                  |
+| workerCount                   | Integer |    4    |    No    | Netty 工作线程数                                                 |
+| accessLog                     | Boolean |  false  |    No    | netty request parameters.                                   |
+| **ServerSocketChannelConfig** |  |         |          |                                                             |
+| soRcvBuf                      | Integer |  87380  |    No    | Socket参数,TCP数据接收缓冲区大小                                       |
+| soBackLog                     | Integer |   128   |    No    | Socket参数,服务端接受连接的队列长度                                       |
+| soReuseAddr                   | Boolean |  false  |    No    | Socket 参数,是否复用地址                                            |
+| connectTimeoutMillis          | Integer |  10000  |    No    | Netty 参数,连接超时时间                                             |
+| writeBufferHighWaterMark      | Integer |  65536  |    No    | Netty 参数,通道水位线上限                                            |
+| writeBufferLowWaterMark       | Integer |  32768  |    No    | Netty 参数,通道水位线下限                                            |
+| writeSpinCount                | Integer |   16    |    No    | Netty参数,一个Loop写操作执行的最大次数                                    |
+| autoRead                      | Boolean |  true   |    No    | Netty参数,自动读取                                                |
+| allocType                     | String  | pooled  |    No    | Netty参数,ByteBuf的分配器                                         |
+| messageSizeEstimator          | Integer |    8    |    No    | Netty参数, 消息大小估算器, 用于估算ByteBuf,ByteBufHolder和FileRegion大小    |
+| singleEventExecutorPerGroup   | Boolean |  true   |    No    | Netty参数, 单线程执行ChannelPipeline中的事件                           |
+| **SocketChannelConfig**       |  |         |          |                                                             |
+| soKeepAlive                   | Boolean |  false  |    No    | Socket 参数,是否启用心跳保活机制                                        |
+| soReuseAddr                   | Boolean |  false  |    No    | Socket 参数,是否复用地址                                            |
+| soLinger                      | Integer |   -1    |    No    | Socket 参数,关闭 Socket 的延迟时间                                   |
+| tcpNoDelay                    | Boolean |  true   |    No    | Socket 参数,是否启用 Nagle 算法                                     |
+| soRcvBuf                      | Integer |  87380  |    No    | Socket参数,TCP数据接收缓冲区大小                                       |
+| soSndBuf                      | Integer |   128   |    No    |                                                             |
+| ipTos                         | Integer |    0    |    No    | IP参数,设置IP头部的Type-of-Service字段,用于描述IP包的优先级和QoS选项             |
+| allowHalfClosure              | Boolean |  false  |    No    | Netty参数,一个连接的远端关闭时本地端是否关闭                                   |
+| connectTimeoutMillis          | Integer |  10000  |    No    | Netty 参数,连接超时时间                                             |
+| writeBufferHighWaterMark      | Integer |  65536  |    No    | Netty 参数,通道水位线上限                                            |
+| writeBufferLowWaterMark       | Integer |  32768  |    No    | Netty 参数,通道水位线下限                                            |
+| writeSpinCount                | Integer |   16    |    No    | Netty参数,一个Loop写操作执行的最大次数                                    |
+| autoRead                      | Boolean |  true   |    No    | Netty参数,自动读取                                                |
+| allocType                     | String | pooled  |    No    | Netty参数,ByteBuf的分配器                                         |
+| messageSizeEstimator          | Integer |    8    |    No    | Netty参数, 消息大小估算器, 用于估算ByteBuf,ByteBufHolder和FileRegion大小    |
+| singleEventExecutorPerGroup   | Boolean |  true   |    No    | Netty参数, 单线程执行ChannelPipeline中的事件                           |
 
 ##### shenyu.instance 配置