You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2022/05/23 14:40:44 UTC
[shardingsphere] branch master updated: Add doc for support netty parameter ChannelOption.SO_BACKLOG (#17882)
This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 9ce5cf4e9c1 Add doc for support netty parameter ChannelOption.SO_BACKLOG (#17882)
9ce5cf4e9c1 is described below
commit 9ce5cf4e9c146dd63b6d1772427f851c59888a35
Author: galaxy <ga...@tencent.com>
AuthorDate: Mon May 23 22:40:37 2022 +0800
Add doc for support netty parameter ChannelOption.SO_BACKLOG (#17882)
* Support netty parameter ChannelOption.SO_BACKLOG configurable (#17812)
* Add doc for support netty parameter ChannelOption.SO_BACKLOG (#17812)
---
.../shardingsphere-proxy/yaml-config/props.cn.md | 39 +++++++++++-----------
.../shardingsphere-proxy/yaml-config/props.en.md | 1 +
.../src/main/resources/conf/server.yaml | 1 +
3 files changed, 22 insertions(+), 19 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
index 1775f6c9857..3fafd94a2eb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
@@ -10,25 +10,26 @@ Apache ShardingSphere 提供属性配置的方式配置系统级配置。
## 配置项说明
-| *名称* | *数据类型* | *说明* | *默认值* | *动态生效* |
-|-------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------|----------|--------|
-| sql-show (?) | boolean | 是否在日志中打印 SQL。 <br /> 打印 SQL 可以帮助开发者快速定位系统问题。日志内容包含：逻辑 SQL，真实 SQL 和 SQL 解析结果。<br /> 如果开启配置，日志将使用 Topic `ShardingSphere-SQL`，日志级别是 INFO。 | false | 是 |
-| sql-simple (?) | boolean | 是否在日志中打印简单风格的 SQL。 | false | 是 |
-| kernel-executor-size (?) | int | 用于设置任务处理线程池的大小。每个 ShardingSphereDataSource 使用一个独立的线程池，同一个 JVM 的不同数据源不共享线程池。 | infinite | 否 |
-| max-connections-size-per-query (?) | int | 一次查询请求在每个数据库实例中所能使用的最大连接数。 | 1 | 是 |
-| check-table-metadata-enabled (?) | boolean | 在程序启动和更新时，是否检查分片元数据的结构一致性。 | false | 是 |
-| proxy-frontend-flush-threshold (?) | int | 在 ShardingSphere-Proxy 中设置传输数据条数的 IO 刷新阈值。 | 128 | 是 |
-| proxy-opentracing-enabled (?) | boolean | 是否允许在 ShardingSphere-Proxy 中使用 OpenTracing。 | false | 是 |
-| proxy-hint-enabled (?) | boolean | 是否允许在 ShardingSphere-Proxy 中使用 Hint。使用 Hint 会将 Proxy 的线程处理模型由 IO 多路复用变更为每个请求一个独立的线程，会降低 Proxy 的吞吐量。 | false | 是 |
-| proxy-backend-query-fetch-size (?) | int | Proxy 后端与数据库交互的每次获取数据行数（使用游标的情况下）。数值增大可能会增加 ShardingSphere Proxy 的内存使用。默认值为 -1，代表设置为 JDBC 驱动的最小值。 | -1 | 是 |
-| check-duplicate-table-enabled (?) | boolean | 在程序启动和更新时，是否检查重复表。 | false | 是 |
-| proxy-frontend-executor-size (?) | int | Proxy 前端 Netty 线程池线程数量，默认值 0 代表使用 Netty 默认值。 | 0 | 否 |
-| proxy-backend-executor-suitable (?) | String | 可选选项：OLAP、OLTP。OLTP 选项可能会减少向客户端写入数据包的时间开销，但如果客户端连接数超过 `proxy-frontend-executor-size`，尤其是执行慢 SQL 时，它可能会增加 SQL 执行的延迟甚至阻塞其他客户端的连接。 | OLAP | 是 |
-| proxy-frontend-max-connections (?) | int | 允许连接 Proxy 的最大客户端数量，默认值 0 代表不限制。 | 0 | 是 |
-| sql-federation-enabled (?) | boolean | 是否开启 federation 查询。 | false | 是 |
-| show-process-list-enabled (?) | boolean | 是否开启 processlist 功能，同时仅在 Cluster 模式生效。功能和 MySQL show processlist 类似。目前只对 DDL 和 DML 语句生效。 | false | 是 |
-| proxy-mysql-default-version (?) | String | Proxy 通过配置文件指定 MySQL 的版本号,默认版本：5.7.22。 | 5.7.22 | 否 |
-| proxy-default-port (?) | String | Proxy 通过配置文件指定默认端口。 | 3307 | 否 |
+| *名称* | *数据类型* | *说明* | *默认值* | *动态生效* |
+|-------------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------|----------|--------|
+| sql-show (?) | boolean | 是否在日志中打印 SQL。 <br /> 打印 SQL 可以帮助开发者快速定位系统问题。日志内容包含：逻辑 SQL，真实 SQL 和 SQL 解析结果。<br /> 如果开启配置，日志将使用 Topic `ShardingSphere-SQL`，日志级别是 INFO。 | false | 是 |
+| sql-simple (?) | boolean | 是否在日志中打印简单风格的 SQL。 | false | 是 |
+| kernel-executor-size (?) | int | 用于设置任务处理线程池的大小。每个 ShardingSphereDataSource 使用一个独立的线程池，同一个 JVM 的不同数据源不共享线程池。 | infinite | 否 |
+| max-connections-size-per-query (?) | int | 一次查询请求在每个数据库实例中所能使用的最大连接数。 | 1 | 是 |
+| check-table-metadata-enabled (?) | boolean | 在程序启动和更新时，是否检查分片元数据的结构一致性。 | false | 是 |
+| proxy-frontend-flush-threshold (?) | int | 在 ShardingSphere-Proxy 中设置传输数据条数的 IO 刷新阈值。 | 128 | 是 |
+| proxy-opentracing-enabled (?) | boolean | 是否允许在 ShardingSphere-Proxy 中使用 OpenTracing。 | false | 是 |
+| proxy-hint-enabled (?) | boolean | 是否允许在 ShardingSphere-Proxy 中使用 Hint。使用 Hint 会将 Proxy 的线程处理模型由 IO 多路复用变更为每个请求一个独立的线程，会降低 Proxy 的吞吐量。 | false | 是 |
+| proxy-backend-query-fetch-size (?) | int | Proxy 后端与数据库交互的每次获取数据行数（使用游标的情况下）。数值增大可能会增加 ShardingSphere Proxy 的内存使用。默认值为 -1，代表设置为 JDBC 驱动的最小值。 | -1 | 是 |
+| check-duplicate-table-enabled (?) | boolean | 在程序启动和更新时，是否检查重复表。 | false | 是 |
+| proxy-frontend-executor-size (?) | int | Proxy 前端 Netty 线程池线程数量，默认值 0 代表使用 Netty 默认值。 | 0 | 否 |
+| proxy-backend-executor-suitable (?) | String | 可选选项：OLAP、OLTP。OLTP 选项可能会减少向客户端写入数据包的时间开销，但如果客户端连接数超过 `proxy-frontend-executor-size`，尤其是执行慢 SQL 时，它可能会增加 SQL 执行的延迟甚至阻塞其他客户端的连接。 | OLAP | 是 |
+| proxy-frontend-max-connections (?) | int | 允许连接 Proxy 的最大客户端数量，默认值 0 代表不限制。 | 0 | 是 |
+| sql-federation-enabled (?) | boolean | 是否开启 federation 查询。 | false | 是 |
+| show-process-list-enabled (?) | boolean | 是否开启 processlist 功能，同时仅在 Cluster 模式生效。功能和 MySQL show processlist 类似。目前只对 DDL 和 DML 语句生效。 | false | 是 |
+| proxy-mysql-default-version (?) | String | Proxy 通过配置文件指定 MySQL 的版本号,默认版本：5.7.22。 | 5.7.22 | 否 |
+| proxy-default-port (?) | String | Proxy 通过配置文件指定默认端口。 | 3307 | 否 |
+| proxy-netty-backlog (?) | int | Proxy 通过配置文件指定默认netty back_log参数。 | 1024 | 否 |
属性配置可以通过 [DistSQL#RAL](/cn/user-manual/shardingsphere-proxy/distsql/syntax/ral/) 修改。
支持动态修改的属性可以立即生效，不支持动态修改的属性需要重启后生效。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
index f1e92d2c009..3cebdb6b83d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
@@ -29,6 +29,7 @@ Apache ShardingSphere provides the way of property configuration to configure sy
| show-process-list-enabled (?) | boolean | Whether enable show process list, and it only take effect when mode is Cluster. This function is similar as MySQL show processlist. It just apply on DDL and DML statements currently. | false | true |
| proxy-mysql-default-version (?) | String | Proxy specifies MySQL server version. The default value is 5.7.22. | 5.7.22 | false |
| proxy-default-port (?) | String | Proxy specifies the default port through the configuration file. | 3307 | false |
+| proxy-netty-backlog (?) | int | Proxy set netty back_log parameter via configuration file. | 1024 | false |
Properties can be updated by [DistSQL#RAL](/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/).
Dynamic update can take effect immediately, static update can take effect after restarted.
diff --git a/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml b/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
index c1dff87edf6..4538a7d230d 100644
--- a/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
+++ b/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
@@ -81,3 +81,4 @@
# proxy-backend-driver-type: JDBC
# proxy-mysql-default-version: 5.7.22 # In the absence of schema name, the default version will be used.
# proxy-default-port: 3307 # Proxy default port.
+# proxy-netty-backlog: 1024 # Proxy netty backlog.