[Mysql] Apply initial setup time to Debezium setup time #32662

xiaohansong · 2023-11-17T21:22:37Z

Fix https://github.com/airbytehq/oncall/issues/3567

Some DB has large number of tables to sync. In that case, our default 5 minutes wait time is not enough. The change is to make initial setup time defined by user also applies to that default debezium setup time if it's larger.

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
Documentation which references the generator is updated as needed

Updating the Python CDK

Airbyter

Before merging:

Pull Request description explains what problem it is solving
Code change is unit tested
Build and my-py check pass
Smoke test the change on at least one affected connector
- On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
- Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
PR is reviewed and approved

After merging:

Publish the CDK
- The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
- Write a thoughtful changelog message so we know what was updated.
Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
- This step is optional if the change does not affect the connector builder or declarative connectors.

vercel · 2023-11-17T21:22:43Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
airbyte-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 28, 2023 5:22pm

akashkulk · 2023-11-27T17:57:36Z

airbyte-cdk/java/airbyte-cdk/core/src/main/java/io/airbyte/cdk/db/jdbc/JdbcUtils.java

@@ -55,6 +55,7 @@ public class JdbcUtils {
  public static final String TLS_KEY = "tls";
  public static final String USERNAME_KEY = "username";
  public static final String MODE_KEY = "mode";
+  public static final String ENGINE_WARMUP_MINUTE_KEY = "engine_warmup_minute";


Are we adding this to the spec as a user configured option? IMO maybe we shouldn't present this option to the user as it might be confusing to have 2 timeouts.

We already provide the initial record waiting time option to the user. What we can do is :

Have logic that defaults the minimum value to 5 min (current time)

If the user has defined the initial wait time > 5 min, we can set it to that.

What do you think? Also what was the new time that worked for the OC issue?

yeah that sounds good! I was thinking just to add that so in our backend we could adjust this in oncall operations; but I think your proposal makes more sense.

In the OC issue the timeout was 9 minutes 30 seconds; so adjusting initial wait time should work

akashkulk · 2023-11-27T19:26:03Z

...c/main/java/io/airbyte/cdk/integrations/debezium/internals/mysql/MySqlDebeziumStateUtil.java

-          if (Duration.between(engineStartTime, Instant.now()).compareTo(Duration.ofMinutes(5L)) > 0) {
-            LOGGER.error("No record is returned even after 5 minutes of waiting, closing the engine");
+          final Duration initialWaitingDuration = database.getSourceConfig().has(INITIAL_WAITING_SECONDS) ? Duration
+              .ofSeconds(database.getSourceConfig().get(INITIAL_WAITING_SECONDS).asLong()) : Duration.ofMinutes(5L);


I think just to not change the minimum default (since we were seeing some timeouts), we should take the max (5 min, user_configured_first_wait_time)

good call - fixed!

akashkulk · 2023-11-27T19:39:42Z

...c/main/java/io/airbyte/cdk/integrations/debezium/internals/mysql/MySqlDebeziumStateUtil.java

@@ -53,6 +53,7 @@
 public class MySqlDebeziumStateUtil implements DebeziumStateUtil {

  private static final Logger LOGGER = LoggerFactory.getLogger(MySqlDebeziumStateUtil.class);
+  private static final String INITIAL_WAITING_SECONDS = "initial_waiting_seconds";


nit : can we reuse the method RecordWaitTimeUtil.getFirstRecordWaitSeconds() instead of re-read this?

akashkulk

Approving - one small nit about PR description + changelog comment : I think that you should mention that initial wait time is already configurable - but this is extending the wait time to read schema history from Debezium

xiaohansong · 2023-11-28T01:06:03Z

/publish-java-cdk

🕑 https://github.com/airbytehq/airbyte/actions/runs/7012762143
✅ Successfully published Java CDK version=0.5.1!

make initial setup time configurable

f03c718

xiaohansong requested a review from akashkulk November 17, 2023 21:22

octavia-squidington-iii added the CDK Connector Development Kit label Nov 17, 2023

toggle cdk local

4e40a3b

xiaohansong requested a review from a team as a code owner November 17, 2023 22:36

octavia-squidington-iii added area/connectors Connector related issues connectors/source/mysql labels Nov 17, 2023

strict encrypt mysql

8075064

octavia-squidington-iii added the connectors/source/mysql-strict-encrypt label Nov 17, 2023

akashkulk reviewed Nov 27, 2023

View reviewed changes

xiaohansong added 2 commits November 27, 2023 10:44

comments

43a6f44

Merge remote-tracking branch 'origin/master' into xiaohan/waittime

224fd2c

xiaohansong requested a review from akashkulk November 27, 2023 18:45

octavia-squidington-iii removed the area/connectors Connector related issues label Nov 27, 2023

vercel bot deployed to Preview November 27, 2023 18:49 View deployment

connector refers to local CDK

3192006

octavia-squidington-iii added the area/connectors Connector related issues label Nov 27, 2023

add doc

b4f8a21

akashkulk reviewed Nov 27, 2023

View reviewed changes

minimum 5 minutes wait time

42ca376

xiaohansong requested a review from akashkulk November 27, 2023 19:32

akashkulk reviewed Nov 27, 2023

View reviewed changes

reuse util

ed881cc

xiaohansong requested a review from akashkulk November 27, 2023 22:29

Merge remote-tracking branch 'origin/master' into xiaohan/waittime

76794e8

vercel bot deployed to Preview November 27, 2023 22:33 View deployment

xiaohansong added 3 commits November 27, 2023 14:48

fix format

f006b43

rename issue

61ada21

bump up version

03ee829

xiaohansong added 2 commits November 27, 2023 16:09

add dependency (diff did not merge correctly)

e69f1b0

one more missed fix

5920400

akashkulk approved these changes Nov 28, 2023

View reviewed changes

xiaohansong changed the title ~~[Mysql] Make initial setup time configurable~~ [Mysql] Apply initial setup time to Debezium setup time Nov 28, 2023

doc update

17703a9

octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Nov 28, 2023

vercel bot deployed to Preview November 28, 2023 00:35 View deployment

xiaohansong added 2 commits November 27, 2023 17:10

use new published cdk

ea62ca7

Merge remote-tracking branch 'origin/master' into xiaohan/waittime

ebd9211

xiaohansong enabled auto-merge (squash) November 28, 2023 17:44

xiaohansong disabled auto-merge November 28, 2023 17:48

xiaohansong merged commit d7c8f35 into master Nov 28, 2023
24 checks passed

xiaohansong deleted the xiaohan/waittime branch November 28, 2023 21:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Mysql] Apply initial setup time to Debezium setup time #32662

[Mysql] Apply initial setup time to Debezium setup time #32662

xiaohansong commented Nov 17, 2023 •

edited

vercel bot commented Nov 17, 2023 •

edited

akashkulk Nov 27, 2023

xiaohansong Nov 27, 2023

akashkulk Nov 27, 2023

xiaohansong Nov 27, 2023

akashkulk Nov 27, 2023

akashkulk left a comment

xiaohansong commented Nov 28, 2023 •

edited by github-actions bot

[Mysql] Apply initial setup time to Debezium setup time #32662

[Mysql] Apply initial setup time to Debezium setup time #32662

Conversation

xiaohansong commented Nov 17, 2023 • edited

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Airbyter

vercel bot commented Nov 17, 2023 • edited

akashkulk Nov 27, 2023

Choose a reason for hiding this comment

xiaohansong Nov 27, 2023

Choose a reason for hiding this comment

akashkulk Nov 27, 2023

Choose a reason for hiding this comment

xiaohansong Nov 27, 2023

Choose a reason for hiding this comment

akashkulk Nov 27, 2023

Choose a reason for hiding this comment

akashkulk left a comment

Choose a reason for hiding this comment

xiaohansong commented Nov 28, 2023 • edited by github-actions bot

xiaohansong commented Nov 17, 2023 •

edited

vercel bot commented Nov 17, 2023 •

edited

xiaohansong commented Nov 28, 2023 •

edited by github-actions bot