Progress Bar Estimate #19814

davinchia · 2022-11-26T18:51:59Z

What

Implement estimate message processing allowing the platform to hold on to estimate message counts in memory.

The estimate message is protocol message connectors can choose to emit to provide support for progress bar calculations. There are two kinds of estimates, per-Sync or per-Stream. Sources cannot emit both types in a single sync.

Per-stream estimates are what we usually expect. Per-sync estimates are for sources that cannot provide more granular estimates for whatever reasons e.g. CDC sources.

In a follow up PR, the platform will periodically save these messages through the save stats api.

How

add getStreamToEstimatedRecords, getStreamToEstimatedBytes, getTotalRecordsEstimated and getTotalBytesEstimated to the MessageTracker interface.
implement the above methods.
add tests.

Also took the chance to clean up some of the testing code.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
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.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub and connector version bumped by running the /publish command described here

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:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

…erTest classes.

davinchia · 2022-11-26T18:52:47Z

airbyte-commons-worker/src/main/java/io/airbyte/workers/test_utils/AirbyteMessageUtils.java

-        .withType(io.airbyte.protocol.models.AirbyteTraceMessage.Type.ERROR)
-        .withEmittedAt(emittedAt)
-        .withError(new AirbyteErrorTraceMessage().withMessage(message));
+    return createErrorTraceMessage(message, emittedAt, null);


consolidate the various trace message creation into one function to avoid duplication.

airbyte-commons-worker/src/main/java/io/airbyte/workers/test_utils/AirbyteMessageUtils.java

.

davinchia · 2022-11-28T20:59:09Z

I have updated the logic and tests to account for the difference between Stream and Sync estimates!

gosusnp

Looks good in principle, left some questions.

gosusnp · 2022-11-28T21:41:24Z

airbyte-commons-worker/src/main/java/io/airbyte/workers/internal/AirbyteMessageTracker.java

  private final StateDeltaTracker stateDeltaTracker;
  private final StateMetricsTracker stateMetricsTracker;
  private final List<AirbyteTraceMessage> destinationErrorTraceMessages;
  private final List<AirbyteTraceMessage> sourceErrorTraceMessages;
  private final StateAggregator stateAggregator;
  private final boolean logConnectorMessages = new EnvVariableFeatureFlags().logConnectorMessages();

+  // These variables support SYNC level estimates and are meant for sources where stream level
+  // estimates are not possible e.g. CDC sources.
+  private Long totalRecordsEstimatedSync;


Looks like we are adding a new concept of Sync vs Stream, instead, would it make sense to use STREAM vs GLOBAL?

I'm following from the AirbyteTraceEstimateMessage type. Slight preference to keep the names consistent though happy to change the name within this file to Global.

With the AirbyteTraceEstiamteMessage, I do think STREAM vs SYNC are decent names for now.

I am thinking about consistency for the near future, Sync feels very coupled to how we current run the replication. For STREAM, I think we want to modify our current replication model to be able to replicate data at stream level rather than connection. If we are running per stream replication in parallel, Sync mode for progress looks outdated.

It probably feels more like future-proofing, I don't have reasons to feel strongly either way at this moment.

Agree with your thoughts. Honestly, not 100% how the stream-as-first-class citizen refactor will play with CDC w.r.t the stats here.

In that case, I'm guessing we will be able to do away with the SYNC field. I'm inclined to keep this as is for now and revisit when we cross that. How does that sound?

Sounds good to me, conceptually, I think we are tracking the right way, we can address the naming later on.

airbyte-commons-worker/src/main/java/io/airbyte/workers/internal/AirbyteMessageTracker.java

Follow up from ##19814, where we introduced the StreamStats object to consolidate/simplify some of the stats memory objects. In this PR, we extend the StreamStats object to also include the emitted records and bytes. - Make StreamStats into a proper object. We cannot use a record as record fields are immutable. We need mutable fields to count. - Consolidate the emitted records into StreamStats. - Take the chance to move all the stats/metrics related classes into a book_keeping package to keep things clean.

davinchia added 3 commits November 26, 2022 09:51

Add all the required interface methods for message tracking.

10aaa8c

Slight reformat.

63436da

Minor refactor of the AirbyteMessageUtils and the AirbyteMessageTrack…

b86fdf3

…erTest classes.

octavia-squidington-iv added area/platform issues related to the platform area/worker Related to worker labels Nov 26, 2022

davinchia commented Nov 26, 2022

View reviewed changes

davinchia requested review from evantahler, pmossman and gosusnp November 26, 2022 18:55

davinchia marked this pull request as ready for review November 26, 2022 18:55

Make test literals variables.

6dee0fd

davinchia commented Nov 26, 2022

View reviewed changes

airbyte-commons-worker/src/main/java/io/airbyte/workers/test_utils/AirbyteMessageUtils.java Outdated Show resolved Hide resolved

davinchia temporarily deployed to more-secrets November 26, 2022 18:58 Inactive

Add javadocs.

ea43a2d

davinchia temporarily deployed to more-secrets November 26, 2022 19:10 Inactive

evantahler mentioned this pull request Nov 28, 2022

Add description for AirbyteEstimateTraceMessage types #19843

Merged

Add logic to distinguish between SYNC and STREAM messages/

2effea7

.

davinchia temporarily deployed to more-secrets November 28, 2022 19:56 Inactive

Update message utils to reflect STREAM vs SYNC estimates.

3dfefc7

davinchia temporarily deployed to more-secrets November 28, 2022 20:05 Inactive

Add tests to clarify stream and sync estimate behavior.

8cf5dde

davinchia temporarily deployed to more-secrets November 28, 2022 20:57 Inactive

Format and add more tests.

8117afa

davinchia temporarily deployed to more-secrets November 28, 2022 21:17 Inactive

Merge branch 'master' into davinchia/progress-bar-estimate

d2b3e52

davinchia temporarily deployed to more-secrets November 28, 2022 21:32 Inactive

davinchia temporarily deployed to more-secrets November 28, 2022 21:34 Inactive

gosusnp reviewed Nov 28, 2022

View reviewed changes

davinchia added 2 commits November 28, 2022 15:37

Respond to PR feedback.

225f541

Use the StreamStats POJO instead of creating new maps.

ace577f

davinchia temporarily deployed to more-secrets November 29, 2022 00:11 Inactive

Use the StreamStats POJO instead of creating new maps.

ca082fe

davinchia temporarily deployed to more-secrets November 29, 2022 00:30 Inactive

gosusnp approved these changes Nov 29, 2022

View reviewed changes

davinchia merged commit a1b9db5 into master Nov 29, 2022

davinchia deleted the davinchia/progress-bar-estimate branch November 29, 2022 05:16

octavia-squidington-iii mentioned this pull request Nov 30, 2022

Bump Airbyte version from 0.40.22 to 0.40.23 #19941

Merged

davinchia mentioned this pull request Dec 1, 2022

Further simplify metrics tracker. #19988

Merged

37 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Progress Bar Estimate #19814

Progress Bar Estimate #19814

davinchia commented Nov 26, 2022 •

edited by swyxio

Loading

davinchia Nov 26, 2022

davinchia commented Nov 28, 2022

gosusnp left a comment

gosusnp Nov 28, 2022

davinchia Nov 28, 2022

gosusnp Nov 28, 2022

davinchia Nov 29, 2022

gosusnp Nov 29, 2022

Progress Bar Estimate #19814

Progress Bar Estimate #19814

Conversation

davinchia commented Nov 26, 2022 • edited by swyxio Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

davinchia Nov 26, 2022

Choose a reason for hiding this comment

davinchia commented Nov 28, 2022

gosusnp left a comment

Choose a reason for hiding this comment

gosusnp Nov 28, 2022

Choose a reason for hiding this comment

davinchia Nov 28, 2022

Choose a reason for hiding this comment

gosusnp Nov 28, 2022

Choose a reason for hiding this comment

davinchia Nov 29, 2022

Choose a reason for hiding this comment

gosusnp Nov 29, 2022

Choose a reason for hiding this comment

davinchia commented Nov 26, 2022 •

edited by swyxio

Loading