use efm2 plugin by default

aws · Jan 12, 2024 · ef33a25 · ef33a25
1 parent 416ce83
commit ef33a25
Show file tree

Hide file tree

Showing 22 changed files with 34 additions and 34 deletions.
diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java
@@ -386,7 +386,7 @@ Properties useAuroraHostListAndReadWriteSplittingPluginWithReaderLoadBalancing()
 
   Properties useTelemetry() {
     final Properties properties = new Properties();
-    properties.setProperty("wrapperPlugins", "dataCache,auroraHostList,efm");
+    properties.setProperty("wrapperPlugins", "dataCache,auroraHostList,efm2");
     properties.setProperty("enableTelemetry", "true");
     properties.setProperty("telemetryMetricsBackend", "none");
     properties.setProperty("telemetryTracesBackend", "none");
@@ -395,7 +395,7 @@ Properties useTelemetry() {
 
   Properties disabledTelemetry() {
     final Properties properties = new Properties();
-    properties.setProperty("wrapperPlugins", "dataCache,auroraHostList,efm");
+    properties.setProperty("wrapperPlugins", "dataCache,auroraHostList,efm2");
     properties.setProperty("enableTelemetry", "false");
     return properties;
   }

diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md
@@ -73,12 +73,12 @@ Plugins are loaded and managed through the Connection Plugin Manager and may be
 
 | Parameter                         | Value     | Required | Description                                                                                                                                                                                          | Default Value                          |
 |-----------------------------------|-----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
-| `wrapperPlugins`                  | `String`  | No       | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm`                                                                                                                     | `auroraConnectionTracker,failover,efm` | 
+| `wrapperPlugins`                  | `String`  | No       | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm2`                                                                                                                    | `auroraConnectionTracker,failover,efm` | 
 | `autoSortWrapperPluginOrder`      | `Boolean` | No       | Allows the AWS JDBC Driver to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed.                                                  | `true`                                 | 
 | `wrapperProfileName`              | `String`  | No       | Driver configuration profile name. Instead of listing plugin codes with `wrapperPlugins`, the driver profile can be set with this parameter. <br><br> Example: See [below](#configuration-profiles). | `null`                                 |
 
 To use a built-in plugin, specify its relevant plugin code for the `wrapperPlugins`.
-The default value for `wrapperPlugins` is `auroraConnectionTracker,failover,efm`. These 3 plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section.
+The default value for `wrapperPlugins` is `auroraConnectionTracker,failover,efm2`. These 3 plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section.
 To override the default plugins, simply provide a new value for `wrapperPlugins`.
 For instance, to use the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md):
 

diff --git a/...AWSDriverExample/src/main/java/software/amazon/AwsIamAuthenticationDatasourceExample.java b/...AWSDriverExample/src/main/java/software/amazon/AwsIamAuthenticationDatasourceExample.java
@@ -58,7 +58,7 @@ public static void main(String[] args) throws SQLException {
       Properties targetDataSourceProps = new Properties();
 
       // Enable the IAM authentication plugin along with failover and host monitoring plugins.
-      targetDataSourceProps.setProperty("wrapperPlugins", "iam,failover,efm");
+      targetDataSourceProps.setProperty("wrapperPlugins", "iam,failover,efm2");
 
       ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
 

diff --git a/...AWSDriverExample/src/main/java/software/amazon/DriverMetaDataConnectionPluginExample.java b/...AWSDriverExample/src/main/java/software/amazon/DriverMetaDataConnectionPluginExample.java
@@ -38,7 +38,7 @@ public static void main(String[] args) throws SQLException {
     final Properties properties = new Properties();
     properties.setProperty("user", USERNAME);
     properties.setProperty("password", PASSWORD);
-    PropertyDefinition.PLUGINS.set(properties, "driverMetaData,failover,efm");
+    PropertyDefinition.PLUGINS.set(properties, "driverMetaData,failover,efm2");
 
     // DriverMetaDataConnectionPlugin Settings
     // Override the return value of DatabaseMetaData#getDriverName to "PostgreSQL JDBC Driver"

diff --git a/examples/AWSDriverExample/src/main/java/software/amazon/PgConnectionSample.java b/examples/AWSDriverExample/src/main/java/software/amazon/PgConnectionSample.java
@@ -35,7 +35,7 @@ public class PgConnectionSample {
   //         + "?user=username"
   //         + "&password=password"
   //         + "&loginTimeout=100"
-  //         + "&wrapperPlugins=failover,efm"
+  //         + "&wrapperPlugins=failover,efm2"
   //         + "&wrapperLogUnclosedConnections=true";
   private static final String USERNAME = "username";
   private static final String PASSWORD = "password";
@@ -49,7 +49,7 @@ public static void main(String[] args) throws SQLException {
     properties.setProperty("loginTimeout", "100");
 
     // Configuring connection properties for the JDBC Wrapper.
-    properties.setProperty("wrapperPlugins", "failover,efm");
+    properties.setProperty("wrapperPlugins", "failover,efm2");
     properties.setProperty("wrapperLogUnclosedConnections", "true");
 
     try (Connection conn = DriverManager.getConnection(CONNECTION_STRING, properties);

diff --git a/examples/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingMySQLExample.java b/examples/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingMySQLExample.java
@@ -42,8 +42,8 @@ public static void main(String[] args) throws SQLException {
 
     final Properties props = new Properties();
 
-    // Enable readWriteSplitting, failover, and efm plugins and set properties
-    props.setProperty(PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm");
+    // Enable readWriteSplitting, failover, and efm2 plugins and set properties
+    props.setProperty(PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm2");
     props.setProperty(PropertyDefinition.USER.name, USERNAME);
     props.setProperty(PropertyDefinition.PASSWORD.name, PASSWORD);
 

diff --git a/...les/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingPostgresExample.java b/...les/AWSDriverExample/src/main/java/software/amazon/ReadWriteSplittingPostgresExample.java
@@ -44,8 +44,8 @@ public static void main(String[] args) throws SQLException {
 
     final Properties props = new Properties();
 
-    // Enable readWriteSplitting, failover, and efm plugins and set properties
-    props.setProperty(PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm");
+    // Enable readWriteSplitting, failover, and efm2 plugins and set properties
+    props.setProperty(PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm2");
     props.setProperty(PropertyDefinition.USER.name, USERNAME);
     props.setProperty(PropertyDefinition.PASSWORD.name, PASSWORD);
 

diff --git a/...ample/src/main/java/software/amazon/ReadWriteSplittingSpringJdbcTemplateMySQLExample.java b/...ample/src/main/java/software/amazon/ReadWriteSplittingSpringJdbcTemplateMySQLExample.java
@@ -88,7 +88,7 @@ private static DataSource getSimpleMySQLDataSource() {
 
     Properties targetDataSourceProps = new Properties();
     targetDataSourceProps.setProperty(
-        PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm");
+        PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm2");
 
     ds.setUser(USERNAME);
     ds.setPassword(PASSWORD);
@@ -118,7 +118,7 @@ private static DataSource getHikariCPDataSource() {
 
     Properties targetDataSourceProps = new Properties();
     targetDataSourceProps.setProperty(PropertyDefinition.PLUGINS.name,
-        "readWriteSplitting,failover,efm");
+        "readWriteSplitting,failover,efm2");
 
     ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
 

diff --git a/...le/src/main/java/software/amazon/ReadWriteSplittingSpringJdbcTemplatePostgresExample.java b/...le/src/main/java/software/amazon/ReadWriteSplittingSpringJdbcTemplatePostgresExample.java
@@ -87,7 +87,7 @@ private static DataSource getSimplePostgresDataSource() {
 
     Properties targetDataSourceProps = new Properties();
     targetDataSourceProps.setProperty(
-        PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm");
+        PropertyDefinition.PLUGINS.name, "readWriteSplitting,failover,efm2");
 
     ds.setUser(USERNAME);
     ds.setPassword(PASSWORD);
@@ -117,7 +117,7 @@ private static DataSource getHikariCPDataSource() {
 
     Properties targetDataSourceProps = new Properties();
     targetDataSourceProps.setProperty(PropertyDefinition.PLUGINS.name,
-        "readWriteSplitting,failover,efm");
+        "readWriteSplitting,failover,efm2");
 
     ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
 

diff --git a/examples/AWSDriverExample/src/main/java/software/amazon/TelemetryMetricsOTLPExample.java b/examples/AWSDriverExample/src/main/java/software/amazon/TelemetryMetricsOTLPExample.java
@@ -70,7 +70,7 @@ public static void main(String[] args) throws SQLException {
 
     // Properties
     final Properties properties = new Properties();
-    properties.setProperty(PropertyDefinition.PLUGINS.name, "dataCache, efm, failover");
+    properties.setProperty(PropertyDefinition.PLUGINS.name, "dataCache,efm2,failover");
     properties.setProperty(PropertyDefinition.USER.name, USERNAME);
     properties.setProperty(PropertyDefinition.PASSWORD.name, PASSWORD);
 

diff --git a/examples/AWSDriverExample/src/main/java/software/amazon/TelemetryTracingXRayExample.java b/examples/AWSDriverExample/src/main/java/software/amazon/TelemetryTracingXRayExample.java
@@ -45,7 +45,7 @@ public static void main(String[] args) throws SQLException {
 
     // Properties
     final Properties properties = new Properties();
-    properties.setProperty(PropertyDefinition.PLUGINS.name, "dataCache, efm, failover");
+    properties.setProperty(PropertyDefinition.PLUGINS.name, "dataCache,efm2,failover");
     properties.setProperty(PropertyDefinition.USER.name, USERNAME);
     properties.setProperty(PropertyDefinition.PASSWORD.name, PASSWORD);
 

diff --git a/examples/HikariExample/src/main/java/software/amazon/HikariFailoverExample.java b/examples/HikariExample/src/main/java/software/amazon/HikariFailoverExample.java
@@ -70,7 +70,7 @@ public static void main(String[] args) throws SQLException {
       // targetDataSourceProps.setProperty("ssl", "true");
 
       // Enable the failover and host monitoring connection plugins.
-      targetDataSourceProps.setProperty("wrapperPlugins", "failover,efm");
+      targetDataSourceProps.setProperty("wrapperPlugins", "failover,efm2");
 
       ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
 

diff --git a/examples/SpringBootHikariExample/README.md b/examples/SpringBootHikariExample/README.md
@@ -79,7 +79,7 @@ spring:
     driver-class-name: software.amazon.jdbc.Driver
     hikari:
       data-source-properties:
-        wrapperPlugins: failover,efm
+        wrapperPlugins: failover,efm2
         wrapperDialect: aurora-pg
       exception-override-class-name: software.amazon.jdbc.util.HikariCPSQLException
 ```
@@ -95,7 +95,7 @@ spring:
     driver-class-name: software.amazon.jdbc.Driver
     hikari:
       data-source-properties:
-        wrapperPlugins: failover,efm
+        wrapperPlugins: failover,efm2
         wrapperDialect: aurora-pg
       exception-override-class-name: software.amazon.jdbc.util.HikariCPSQLException
       max-lifetime: 840000

diff --git a/examples/SpringBootHikariExample/src/main/resources/application.yml b/examples/SpringBootHikariExample/src/main/resources/application.yml
@@ -6,7 +6,7 @@ spring:
     driver-class-name: software.amazon.jdbc.Driver
     hikari:
       data-source-properties:
-        wrapperPlugins: failover,efm
+        wrapperPlugins: failover,efm2
         wrapperDialect: aurora-pg
       max-lifetime: 840000
       minimum-idle: 20

diff --git a/examples/SpringHibernateExample/README.md b/examples/SpringHibernateExample/README.md
@@ -149,7 +149,7 @@ Configure Spring to use the AWS Advanced JDBC Driver as the default datasource.
         driver-class-name: software.amazon.jdbc.Driver
         hikari:
           data-source-properties:
-            wrapperPlugins: iam,failover,efm
+            wrapperPlugins: iam,failover,efm2
             iamRegion: us-east-2
             iamExpiration: 1320
           exception-override-class-name: software.amazon.jdbc.util.HikariCPSQLException

diff --git a/examples/SpringHibernateExample/src/main/resources/application.yml b/examples/SpringHibernateExample/src/main/resources/application.yml
@@ -5,7 +5,7 @@ spring:
     driver-class-name: software.amazon.jdbc.Driver
     hikari:
       data-source-properties:
-        wrapperPlugins: iam,failover,efm
+        wrapperPlugins: iam,failover,efm2
         iamRegion: us-east-2
         iamExpiration: 1320
       exception-override-class-name: software.amazon.jdbc.util.HikariCPSQLException

diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java
@@ -109,7 +109,7 @@ public class ConnectionPluginChainBuilder {
         }
       };
 
-  protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover,efm";
+  protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover,efm2";
 
   /*
    Internal class used for plugin factory sorting. It holds a reference to a plugin

diff --git a/wrapper/src/main/java/software/amazon/jdbc/profile/DriverConfigurationProfiles.java b/wrapper/src/main/java/software/amazon/jdbc/profile/DriverConfigurationProfiles.java
@@ -31,8 +31,8 @@
 import software.amazon.jdbc.plugin.AuroraConnectionTrackerPluginFactory;
 import software.amazon.jdbc.plugin.AuroraHostListConnectionPluginFactory;
 import software.amazon.jdbc.plugin.AuroraInitialConnectionStrategyPluginFactory;
-import software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPlugin;
-import software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPluginFactory;
+import software.amazon.jdbc.plugin.efm2.HostMonitoringConnectionPlugin;
+import software.amazon.jdbc.plugin.efm2.HostMonitoringConnectionPluginFactory;
 import software.amazon.jdbc.plugin.failover.FailoverConnectionPluginFactory;
 import software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPluginFactory;
 import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsPluginFactory;

diff --git a/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java b/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java
@@ -80,7 +80,7 @@ protected static Properties getProps() {
 
   protected static Properties getPropsWithFailover() {
     final Properties props = getDefaultPropsNoPlugins();
-    PropertyDefinition.PLUGINS.set(props, "readWriteSplitting,failover,efm");
+    PropertyDefinition.PLUGINS.set(props, "readWriteSplitting,failover,efm2");
     return props;
   }
 

diff --git a/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java b/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java
@@ -123,7 +123,7 @@ protected static Properties getProps() {
 
   protected static Properties getPropsWithFailover() {
     final Properties props = getDefaultPropsNoPlugins();
-    PropertyDefinition.PLUGINS.set(props, "readWriteSplitting,failover,efm");
+    PropertyDefinition.PLUGINS.set(props, "readWriteSplitting,failover,efm2");
     return props;
   }
 

diff --git a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginChainBuilderTests.java b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginChainBuilderTests.java
@@ -37,7 +37,7 @@
 import software.amazon.jdbc.plugin.ExecutionTimeConnectionPlugin;
 import software.amazon.jdbc.plugin.IamAuthConnectionPlugin;
 import software.amazon.jdbc.plugin.dev.DeveloperConnectionPlugin;
-import software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPlugin;
+import software.amazon.jdbc.plugin.efm2.HostMonitoringConnectionPlugin;
 import software.amazon.jdbc.plugin.failover.FailoverConnectionPlugin;
 import software.amazon.jdbc.util.telemetry.TelemetryContext;
 import software.amazon.jdbc.util.telemetry.TelemetryFactory;
@@ -69,7 +69,7 @@ void beforeEach() {
   public void testSortPlugins() throws SQLException {
     ConnectionPluginChainBuilder builder = new ConnectionPluginChainBuilder();
     Properties props = new Properties();
-    props.put(PropertyDefinition.PLUGINS.name, "iam,efm,failover");
+    props.put(PropertyDefinition.PLUGINS.name, "iam,efm2,failover");
 
     List<ConnectionPlugin> result = builder.getPlugins(
         mockPluginService,
@@ -91,7 +91,7 @@ public void testSortPlugins() throws SQLException {
   public void testPreservePluginOrder() throws SQLException {
     ConnectionPluginChainBuilder builder = new ConnectionPluginChainBuilder();
     Properties props = new Properties();
-    props.put(PropertyDefinition.PLUGINS.name, "iam,efm,failover");
+    props.put(PropertyDefinition.PLUGINS.name, "iam,efm2,failover");
     props.put(PropertyDefinition.AUTO_SORT_PLUGIN_ORDER.name, "false");
 
     List<ConnectionPlugin> result = builder.getPlugins(
@@ -114,7 +114,7 @@ public void testPreservePluginOrder() throws SQLException {
   public void testSortPluginsWithStickToPrior() throws SQLException {
     ConnectionPluginChainBuilder builder = new ConnectionPluginChainBuilder();
     Properties props = new Properties();
-    props.put(PropertyDefinition.PLUGINS.name, "dev,iam,executionTime,connectTime,efm,failover");
+    props.put(PropertyDefinition.PLUGINS.name, "dev,iam,executionTime,connectTime,efm2,failover");
 
     List<ConnectionPlugin> result = builder.getPlugins(
         mockPluginService,

diff --git a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java
@@ -47,7 +47,7 @@
 import software.amazon.jdbc.plugin.AuroraConnectionTrackerPlugin;
 import software.amazon.jdbc.plugin.DefaultConnectionPlugin;
 import software.amazon.jdbc.plugin.LogQueryConnectionPlugin;
-import software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPlugin;
+import software.amazon.jdbc.plugin.efm2.HostMonitoringConnectionPlugin;
 import software.amazon.jdbc.plugin.failover.FailoverConnectionPlugin;
 import software.amazon.jdbc.profile.ConfigurationProfile;
 import software.amazon.jdbc.profile.ConfigurationProfileBuilder;