Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further simplify metrics tracker. #19988

Merged
merged 3 commits into from
Dec 3, 2022
Merged

Conversation

davinchia
Copy link
Contributor

@davinchia davinchia commented Dec 1, 2022

What

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.

How

  • 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.

Recommended reading order

  1. AirbyteMessageTracker.java and StreamStats.java - for the main changes.
  2. Everything else.

🚨 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

  • Community member? 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
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • 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 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.

@octavia-squidington-iv octavia-squidington-iv added area/platform issues related to the platform area/server area/worker Related to worker labels Dec 1, 2022
@davinchia davinchia temporarily deployed to more-secrets December 1, 2022 16:53 Inactive
@davinchia davinchia marked this pull request as ready for review December 1, 2022 17:00
@davinchia davinchia requested review from pmossman and gosusnp and removed request for pmossman December 1, 2022 17:00
@davinchia davinchia temporarily deployed to more-secrets December 1, 2022 17:02 Inactive
@davinchia
Copy link
Contributor Author

PTAL @pmossman and @gosusnp

Parker, I realised I should have tagged you on the original PR - my bad. I was working on this as part of the progress bar work and simplified some of it as I found it getting complicated. One question I had was around memory usage. There is a fair amount of comments on intending keeping memory low e.g the stream indexes. Was that something we saw and we have to be aware of?

Jimmy I don't think we should simplify interfaces yet. I think consolidating the underlying implementation gets us most of the way there and sets us up to tweak the interfaces later.

@davinchia davinchia changed the title Davinchia/simplify metrics tracker Further simplify metrics tracker. Dec 1, 2022
@pmossman
Copy link
Contributor

pmossman commented Dec 1, 2022

@davinchia I can look through the PR later today, but to answer your question about memory usage, this was my first project at Airbyte and I was following the recommended implementation from the issue: #3247

I don't think we were ever actively seeing memory issues, I think it was more a preemptive approach to make sure we never let the memory usage of our stats grow to a point where it'd be concerning

Copy link
Contributor

@pmossman pmossman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@davinchia davinchia merged commit 990931e into master Dec 3, 2022
@davinchia davinchia deleted the davinchia/simplify-metrics-tracker branch December 3, 2022 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/platform issues related to the platform area/server area/worker Related to worker
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants