support tcp parameter configuration (#337)

* support  tcp parameter configuration

fix

fix

* add directory

Author: ylinzhu

1.config_file/1.02_bootstrap.cnf.md

@@ -1504,6 +1504,47 @@ MaxDirectMemorySize = 0.6 * dble总内存
 <td ><br>  
 <p><sub>合法路径</sub></p><br></td>  
 </tr> 
+<tr>  
+<td rowspan="3" >
+<sub>tcp相关参数</sub></td>
+<td ><br>  
+<p><sub>tcpKeepIdle</sub></p><br></td>  
+<td ><br>  
+<p><sub>启用tcp-keepalive连接检测的连接空闲时间</sub></p><br></td>  
+<td ><br>  
+<p><sub>默认为30s,最大值跟使用的操作系统相关</sub></p><br></td>  
+<td ><br>  
+<p><sub>dble连接如果没有数据发送，多久后会发送Keepalive探测分组，生效条件需要指定版本jdk,具体可查看2.38章节内容</sub></p><br></td>  
+<td ><br>  
+<sub>正整数</sub><br></td>  
+</tr>  
+<tr>  
+<td ><br>  
+<p><sub>tcpKeepInterval</sub></p><br></td>  
+<td ><br>  
+<p><sub>启用tcp-keepalive连接检测的时间间隔</sub></p><br></td>  
+<td ><br>  
+<p><sub>默认为10s,最大值跟使用的操作系统相关</sub></p><br></td>  
+<td ><br>  
+<p><sub>dble连接开启tcp-keepalive探活机制后，前后两次探测之间的时间间隔，生效条件需要指定版本jdk,具体可查看2.38章节内容</sub></p><br></td>  
+<td ><br>  
+<sub>正整数</sub><br></td>  
+</tr>  
+<tr>  
+<td ><br>  
+<p><sub>tcpKeepCount</sub></p><br></td>  
+<td ><br>  
+<p><sub>启用tcp-keepalive检测启用后的最大重试次数</sub></p><br></td>  
+<td ><br>  
+<p><sub>默认3</sub></p><br></td>  
+<td ><br>  
+<p><sub>开启tcp-keepalive探活机制后，关闭一个非正常连接之前的最大重试次数，生效条件需要指定版本jdk,具体可查看2.38章节内容</sub></p><br></td>  
+<td ><br>  
+<sub>正整数</sub><br></td>  
+</tr> 
+
+<tr>  
+
 </tbody>  
 </table>   
 
@@ -1745,6 +1786,10 @@ if enable the batch load data
 #-DsqlDumpLogDeleteFileAge=90d
 #-DsqlDumpLogCompressFilePath=*/sqldump-*.log.gz
 
+#-DtcpKeepIdle=30
+#-DtcpKeepInterval=10
+#-DtcpKeepCount=3
+
 ```
 
 

1.config_file/1.04_db.xml.md

@@ -101,7 +101,10 @@ db.xml包含具体的数据库组和实例配置,可以配置多组，每组可
 <td >keepAlive</td>
 <td >heartbeat子元素,心跳发送后的等待响应时间</td>
 <td >默认60秒</td>
-<td >如果dble的心跳在keepAlive时间内没有收到来自msyql的回复，那么就会关闭该连接。在下一次发起心跳的时候使用新的连接向msyql发送心跳请求。</td>
+<td >dble会按照heartbeatPeriodMillis的间隔向dbInstance发送心跳,发起心跳检查的时候会检查心跳连接是否可用,如果当前检查心跳连接的时间大于(上次心跳返回的正常心跳的时间+heartbeatPeriodMillis+keepAlive)的值，则杀掉该连接，在下一个周期换一个连接继续做心跳。
+例如：心跳周期(heartbeatPeriodMillis)10秒，第一次心跳正常，记录心跳返回的时间为13：10：00，接下来的心跳一直没有正常返回，当第九次心跳检测时，当前时间为13：11：20，大于（13：10：00 + 10s + 60s），则认为该连接不可用，则杀掉该连接，
+在下一个周期换一个连接继续做心跳。
+</td>
 </tr>  
 </table>
 

2.Function/2.000_overview.md

@@ -79,4 +79,6 @@
 * [2.35 堆外内存泄露监控](2.35_memory_buffer_monitor.md)
 * [2.36 延迟检测](2.36_delay_detection.md)
 * [2.37 审计日志](2.37_sql_dump_log.md)
+* [2.38 tcp相关参数](2.38_tcp_parameter.md)
+
 

2.Function/2.38_tcp_parameter.md

@@ -0,0 +1,26 @@
+## 2.38 tcp相关参数  
+
+### 2.38.1 介绍  
+dble在启动时会创建与mysql通信的连接池，但是这些连接可能在tcp三次握手时由于某些情况丢失了第三次握手的信息。此时这些连接被mysql直接丢弃，
+而在dble侧并无感知，导致dble的连接池的连接的数量达不到预期设置的值，导致dble出现异常。为了解决这个问题，linux本身就有keep-alive机制，
+并提供对应参数控制，但是这是系统级别参数，一旦直接修改可能影响其他应用影响面较大。dble在bootstrap.cnf中提供相关参数配置并且只影响dble内的连接。
+
+### 2.38.2 jdk版本要求  
+oracle jdk 1.8-261及其以上版本   
+openjdk 1.8-272及其以上版本    
+
+### 2.38.3 相关配置  
+```
+-DtcpKeepIdle=30   #启用tcp-keepalive连接检测的连接空闲时间
+-DtcpKeepInterval=10 #启用tcp-keepalive连接检测的时间间隔
+-DtcpKeepCount=3 #启用tcp-keepalive检测启用后的最大重试次数
+```
+### 2.38.4 使用场景  
+1.检测并关闭tcp三次握手中丢失了第三次握手信息导致的半连接  
+2.检测挂掉的连接，如导致连接挂掉的原因很多，如服务停止、网络波动、宕机、应用重启等  
+3.防止因为网络不活动而断连，如使用NAT代理或者防火墙等  
+
+### 2.38.5 注意事项  
+1.dble会在启动的时候校验jdk版本，如果版本不符合要求dble会给出相应warn日志，并且配置文件的这三个参数不会生效，dble可以正常启动  
+2.该功能属于试用功能，可能导致后端连接异常断开，可通过调大tcpKeepIdle，tcpKeepInterval，tcpKeepCount的值来规避问题  
+

SUMMARY.md

@@ -114,6 +114,7 @@
     * [2.35 堆外内存泄露监控](2.Function/2.35_memory_buffer_monitor.md)
     * [2.36 延迟检测](2.Function/2.36_delay_detection.md)
     * [2.37 审计日志](2.Function/2.37_sql_dump_log.md)
+    * [2.38 tcp相关参数](2.Function/2.38_tcp_parameter.md)
 * [3.语法兼容](3.SQL_Syntax/3.0_overview.md)
     * [3.1 DDL](3.SQL_Syntax/3.1_DDL.md)
         * [3.1.1 DDL&Table Syntax](3.SQL_Syntax/3.1_DDL/3.1.1_DDL&Table_Syntax.md)