Skip to content

Commit 3698e28

Browse files
chore: add notes on efm configuration (#101)
* chore: add notes on efm configuration Co-authored-by: crystall-bitquill <[email protected]>
1 parent 58f111b commit 3698e28

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/using-the-jdbc-wrapper/using-plugins/UsingTheHostMonitoringPlugin.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,22 @@ If a more aggressive approach to failure checking is necessary, all of these par
5252
| `failureDetectionTime` | Integer | No | Interval in milliseconds between sending a SQL query to the server and the first probe to the database node. | `30000` |
5353
| `monitorDisposalTime` | Integer | No | Interval in milliseconds for a monitor to be considered inactive and to be disposed. | `60000` |
5454

55+
The Host Monitoring Connection Plugin may create new monitoring connections to check the database node's availability. You can configure these connection with driver-specific configurations by adding the `monitoring-` prefix to the configuration parameters, like the following example:
56+
57+
```java
58+
final Properties properties = new Properties();
59+
// Configure the timeout values for all, non-monitoring connections.
60+
properties.setProperty("connectTimeout", "30");
61+
properties.setProperty("socketTimeout", "30");
62+
// Configure different timeout values for the monitoring connections.
63+
properties.setProperty("monitoring-connectTimeout", "10");
64+
properties.setProperty("monitoring-socketTimeout", "10");
65+
```
66+
67+
> :heavy_exclamation_mark: **Always ensure you provide a non-zero socket timeout value or a connect timeout value to the Host Monitoring Connection Plugin**
68+
>
69+
> The Host Monitoring Connection Plugin does not have default timeout values such as `connectTimeout` or `socketTimeout` since these values are driver specific. Most JDBC drivers use 0 as the default timeout value. If you **do not** override the default timeout value, the Host Monitoring Connection Plugin may wait forever to establish a monitoring connection in the event where the database node is unavailable.
70+
5571
>### :warning: Warnings About Usage of the AWS Advanced JDBC Wrapper with RDS Proxy
5672
> It is recommended to either disable the Host Monitoring Connection Plugin, or to avoid using RDS Proxy endpoints when the Host Monitoring Connection Plugin is active.
5773
>

0 commit comments

Comments
 (0)