[Doc] add known limitation and settings for connection issue (#167)

Fixed: #166

Co-authored-by: João Duarte <[email protected]>

Author: kaisecheng

CHANGELOG.md

@@ -1,5 +1,6 @@
-## Unreleased
+## 5.4.10
  - Adds retry mechanism when checkout Derby from SVN repository [#158](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/158)
+ - [DOC] add known limitations and settings for connection issue [#167](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/167)
 
 ## 5.4.9
   - Fix Derby missed driver classes when built locally for version 10.15 [#160](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/160)

docs/input-jdbc.asciidoc

@@ -176,6 +176,29 @@ input {
 }
 ---------------------------------------------------------------------------------------------------
 
+==== Database-specific considerations
+
+The JDBC input plugin leverages the https://github.com/jeremyevans/sequel[sequel] library to query databases through their JDBC drivers.
+The implementation of drivers will vary, however, potentially leading to unexpected behavior.
+
+===== Unable to reuse connections
+
+Some databases - such as Sybase or SQL Anywhere - may have issues with stale connections, timing out between scheduled runs and never reconnecting.
+
+To ensure connections are valid before queries are executed, enable <<plugins-{type}s-{plugin}-jdbc_validate_connection>> and set <<plugins-{type}s-{plugin}-jdbc_validation_timeout>> to a shorter interval than the <<plugins-{type}s-{plugin}-schedule>>.
+
+[source,ruby]
+---------------------------------------------------------------------------------------------------
+input {
+  jdbc {
+    schedule => "* * * * *"       # run every minute
+    jdbc_validate_connection => true
+    jdbc_validation_timeout => 50 # 50 seconds
+  }
+}
+---------------------------------------------------------------------------------------------------
+
+
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== Jdbc Input Configuration Options

logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.4.9'
+  s.version         = '5.4.10'
   s.licenses = ['Apache License (2.0)']
   s.summary         = "Integration with JDBC - input and filter plugins"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"