Skip to content

Commit b0edda0

Browse files
sergiyvamzsergiyvamz
committed
code review
1 parent 03d3a25 commit b0edda0

33 files changed

+615
-595
lines changed

‎docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
2323
>
2424
2525

26-
## What Blue/Green Deployment Plugin does? Is it worth to use it?
26+
## What is Blue/Green Deployment Plugin?
2727

2828
During a [Blue/Green switchover](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-switching.html), several significant changes occur to your database configuration:
2929
- Connections to blue nodes terminate at a specific point during the transition
@@ -34,7 +34,7 @@ During a [Blue/Green switchover](https://docs.aws.amazon.com/AmazonRDS/latest/Us
3434

3535

3636
All factors mentioned above may cause application disruption. The AWS Advanced JDBC Driver aims to minimize the application disruption during Blue/Green switchover by performing the following actions:
37-
- Actively monitors Blue/Green switchover status and implements appropriate measures to hold, pass-through, or re-route database traffic
37+
- Actively monitors Blue/Green switchover status and implements appropriate measures to suspend, pass-through, or re-route database traffic
3838
- Prior to Blue/Green switchover initiation, compiles a comprehensive inventory of cluster and instance endpoints for both blue and green nodes along with their corresponding IP addresses
3939
- During the active switchover phase, temporarily suspends execution of JDBC calls to blue nodes, which helps unload database nodes and reduces transaction lag for green nodes, thereby enhancing overall switchover performance
4040
- Substitutes provided hostnames with corresponding IP addresses when establishing new blue connections, effectively eliminating stale DNS data and ensuring connections to current blue nodes
@@ -48,15 +48,15 @@ All factors mentioned above may cause application disruption. The AWS Advanced J
4848
To enable the Blue/Green Deployment functionality, add the plugin code `bg` to the [`wrapperPlugins`](../UsingTheJdbcDriver.md#connection-plugin-manager-parameters) parameter value.
4949
The Blue/Green Deployment Plugin supports the following configuration parameters:
5050

51-
| Parameter | Value | Required | Description | Example Value |
52-
|----------------------------|:-------:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
53-
| `bgdId` | String | If using multiple Blue/Green Deployments, yes; otherwise, no | This parameter is optional and defaults to `1`. When supporting multiple Blue/Green Deployments (BGDs), this parameter becomes mandatory. Each connection string must include the `bgdId` parameter with a value that can be any number or string. However, all connection strings associated with the same Blue/Green Deployment must use identical `bgdId` values, while connection strings belonging to different BGDs must specify distinct values. | `1234`, `abc-1`, `abc-2` |
54-
| `bgConnectTimeout` | Integer | No | Maximum waiting time (in milliseconds) for establishing new connections during a Blue/Green switchover when blue and green traffic is temporarily suspended. | `30000` |
55-
| `bgBaseline` | Integer | No | The baseline interval (ms) for checking Blue/Green Deployment status. | `60000` |
56-
| `bgIncreased` | Integer | No | The increased interval (ms) for checking Blue/Green Deployment status. | `1000` |
57-
| `bgHigh` | Integer | No | The high-frequency interval (ms) for checking Blue/Green Deployment status. | `100` |
58-
| `bgSwitchoverTimeout` | Integer | No | Maximum duration (in milliseconds) allowed for switchover completion. If the switchover process stalls or exceeds this timeframe, the driver will automatically assume completion and resume normal operations. | `180000` |
59-
| `bgHoldNewBlueConnections` | Boolean | No | Enables Blue/Green Deployment switchover to suspend new blue connection requests while the switchover process is in progress. | `false` |
51+
| Parameter | Value | Required | Description | Example Value |
52+
|-------------------------------|:-------:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
53+
| `bgdId` | String | If using multiple Blue/Green Deployments, yes; otherwise, no | This parameter is optional and defaults to `1`. When supporting multiple Blue/Green Deployments (BGDs), this parameter becomes mandatory. Each connection string must include the `bgdId` parameter with a value that can be any number or string. However, all connection strings associated with the same Blue/Green Deployment must use identical `bgdId` values, while connection strings belonging to different BGDs must specify distinct values. | `1234`, `abc-1`, `abc-2` |
54+
| `bgConnectTimeoutMs` | Integer | No | Maximum waiting time (in milliseconds) for establishing new connections during a Blue/Green switchover when blue and green traffic is temporarily suspended. | `30000` |
55+
| `bgBaselineMs` | Integer | No | The baseline interval (ms) for checking Blue/Green Deployment status. | `60000` |
56+
| `bgIncreasedMs` | Integer | No | The increased interval (ms) for checking Blue/Green Deployment status. | `1000` |
57+
| `bgHighMs` | Integer | No | The high-frequency interval (ms) for checking Blue/Green Deployment status. | `100` |
58+
| `bgSwitchoverTimeoutMs` | Integer | No | Maximum duration (in milliseconds) allowed for switchover completion. If the switchover process stalls or exceeds this timeframe, the driver will automatically assume completion and resume normal operations. | `180000` |
59+
| `bgSuspendNewBlueConnections` | Boolean | No | Enables Blue/Green Deployment switchover to suspend new blue connection requests while the switchover process is in progress. | `false` |
6060

6161
The plugin establishes dedicated monitoring connections to track Blue/Green Deployment status. To apply specific configurations to these monitoring connections, add the `blue-green-monitoring-` prefix to any configuration parameter, as shown in the following example:
6262

‎wrapper/build.gradle.kts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -451,13 +451,12 @@ tasks.register<Test>("test-bgd-mysql-rds-instance") {
451451
systemProperty("test-no-performance", "true")
452452
systemProperty("test-no-pg-driver", "true")
453453
systemProperty("test-no-pg-engine", "true")
454-
systemProperty("test-no-mariadb-driver", "true")
454+
//systemProperty("test-no-mariadb-driver", "true") // TODO: verify
455455
systemProperty("test-no-mariadb-engine", "true")
456456
systemProperty("test-no-graalvm", "true")
457457
systemProperty("test-no-openjdk8", "true")
458458
systemProperty("test-no-aurora", "true")
459459
systemProperty("test-no-failover", "true")
460-
//systemProperty("test-no-iam", "true")
461460
systemProperty("test-no-secrets-manager", "true")
462461
systemProperty("test-no-hikari", "true")
463462
systemProperty("test-no-instances-2", "true")
@@ -476,13 +475,12 @@ tasks.register<Test>("test-bgd-mysql-aurora") {
476475
systemProperty("test-no-performance", "true")
477476
systemProperty("test-no-pg-driver", "true")
478477
systemProperty("test-no-pg-engine", "true")
479-
systemProperty("test-no-mariadb-driver", "true")
478+
//systemProperty("test-no-mariadb-driver", "true") // TODO: verify
480479
systemProperty("test-no-mariadb-engine", "true")
481480
systemProperty("test-no-graalvm", "true")
482481
systemProperty("test-no-openjdk8", "true")
483482
systemProperty("test-no-multi-az-instance", "true")
484483
systemProperty("test-no-failover", "true")
485-
//systemProperty("test-no-iam", "true")
486484
systemProperty("test-no-secrets-manager", "true")
487485
systemProperty("test-no-hikari", "true")
488486
systemProperty("test-no-instances-1", "true")
@@ -508,11 +506,9 @@ tasks.register<Test>("test-bgd-pg-aurora") {
508506
systemProperty("test-no-openjdk8", "true")
509507
systemProperty("test-no-multi-az-instance", "true")
510508
systemProperty("test-no-failover", "true")
511-
//systemProperty("test-no-iam", "true")
512509
systemProperty("test-no-secrets-manager", "true")
513510
systemProperty("test-no-hikari", "true")
514511
systemProperty("test-no-instances-1", "true")
515-
//systemProperty("test-no-instances-2", "true")
516512
systemProperty("test-no-instances-3", "true")
517513
systemProperty("test-no-instances-5", "true")
518514
systemProperty("test-no-multi-az-cluster", "true")
@@ -534,7 +530,6 @@ tasks.register<Test>("test-bgd-pg-rds-instance") {
534530
systemProperty("test-no-graalvm", "true")
535531
systemProperty("test-no-openjdk8", "true")
536532
systemProperty("test-no-failover", "true")
537-
//systemProperty("test-no-iam", "true")
538533
systemProperty("test-no-secrets-manager", "true")
539534
systemProperty("test-no-hikari", "true")
540535
systemProperty("test-no-instances-2", "true")

‎wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider;
2727
import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin;
2828

29-
public class AuroraMysqlDialect extends MysqlDialect implements SupportBlueGreen {
29+
public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect {
3030

3131
private static final String TOPOLOGY_QUERY =
3232
"SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, "
@@ -117,7 +117,7 @@ public String getBlueGreenStatusQuery() {
117117
}
118118

119119
@Override
120-
public boolean isStatusAvailable(final Connection connection) {
120+
public boolean isBlueGreenStatusAvailable(final Connection connection) {
121121
try {
122122
try (Statement statement = connection.createStatement();
123123
ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) {

‎wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* Suitable for the following AWS PG configurations.
3131
* - Regional Cluster
3232
*/
33-
public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect, SupportBlueGreen {
33+
public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect, BlueGreenDialect {
3434
private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName());
3535

3636
private static final String extensionsSql =
@@ -168,7 +168,7 @@ public String getBlueGreenStatusQuery() {
168168
}
169169

170170
@Override
171-
public boolean isStatusAvailable(final Connection connection) {
171+
public boolean isBlueGreenStatusAvailable(final Connection connection) {
172172
try {
173173
try (Statement statement = connection.createStatement();
174174
ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) {

‎wrapper/src/main/java/software/amazon/jdbc/dialect/SupportBlueGreen.java‎ renamed to ‎wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818

1919
import java.sql.Connection;
2020

21-
public interface SupportBlueGreen {
21+
public interface BlueGreenDialect {
2222
String getBlueGreenStatusQuery();
2323

24-
boolean isStatusAvailable(final Connection connection);
24+
boolean isBlueGreenStatusAvailable(final Connection connection);
2525
}

‎wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import java.util.List;
2525
import software.amazon.jdbc.util.StringUtils;
2626

27-
public class RdsMysqlDialect extends MysqlDialect implements SupportBlueGreen {
27+
public class RdsMysqlDialect extends MysqlDialect implements BlueGreenDialect {
2828

2929
private static final String BG_STATUS_QUERY =
3030
"SELECT * FROM mysql.rds_topology";
@@ -106,7 +106,7 @@ public String getBlueGreenStatusQuery() {
106106
}
107107

108108
@Override
109-
public boolean isStatusAvailable(final Connection connection) {
109+
public boolean isBlueGreenStatusAvailable(final Connection connection) {
110110
try {
111111
try (Statement statement = connection.createStatement();
112112
ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) {

‎wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* - Multi-AZ DB Instance
3232
* - Single DB Instance
3333
*/
34-
public class RdsPgDialect extends PgDialect implements SupportBlueGreen {
34+
public class RdsPgDialect extends PgDialect implements BlueGreenDialect {
3535

3636
private static final Logger LOGGER = Logger.getLogger(RdsPgDialect.class.getName());
3737

@@ -101,7 +101,7 @@ public String getBlueGreenStatusQuery() {
101101
}
102102

103103
@Override
104-
public boolean isStatusAvailable(final Connection connection) {
104+
public boolean isBlueGreenStatusAvailable(final Connection connection) {
105105
try {
106106
try (Statement statement = connection.createStatement();
107107
ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) {

0 commit comments

Comments
 (0)