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

🐛 Normalization: Decrease event buffer size #11267

Merged
merged 12 commits into from
Mar 25, 2022
Merged

Conversation

edgao
Copy link
Contributor

@edgao edgao commented Mar 18, 2022

What

In some (hard to systematically explain) circumstances, normalization actually runs out of memory. We've observed pods occupying as much as 1GB of RAM, which is pretty wild. Upgrading DBT to 1.0.0 (#11051) fixed some of these errors, but sometimes we do still OOM.

Current hypothesis is that this occurs when DBT's event buffer grows too large. It defaults to 100K event capacity; decrease that to 10K.

🚨 User Impact 🚨

This is probably an extreme edge case: If a normalization run generates over 10K event messages, DBT will now drop the earliest messages. I'm pretty sure this only even matters in cases where DBT fails and tries to dump logs to stdout.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

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 by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory 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

@edgao edgao force-pushed the edgao/dbt_event_buffer_size branch from 4f92c1c to f6568f5 Compare March 18, 2022 20:33
@edgao
Copy link
Contributor Author

edgao commented Mar 18, 2022

/test connector=bases/base-normalization

1 similar comment
@edgao
Copy link
Contributor Author

edgao commented Mar 18, 2022

/test connector=bases/base-normalization

@edgao edgao changed the title Normalization: Set event buffer size 🐛 Normalization: Decrease event buffer size Mar 18, 2022
@edgao
Copy link
Contributor Author

edgao commented Mar 21, 2022

/test connector=bases/base-normalization

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2013827960
❌ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2013827960
🐛

@edgao
Copy link
Contributor Author

edgao commented Mar 21, 2022

/test connector=bases/base-normalization

@edgao
Copy link
Contributor Author

edgao commented Mar 21, 2022

/test connector=bases/base-normalization

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2019220765
❌ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2019220765
🐛

@edgao
Copy link
Contributor Author

edgao commented Mar 22, 2022

/test connector=bases/base-normalization

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
❌ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
🐛

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
❌ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
🐛

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
✅ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2024880309
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              275    106    61%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  876    259    70%
Name                                                                                                                            Stmts   Miss  Cover
---------------------------------------------------------------------------------------------------------------------------------------------------
base_python/cdk/utils/casing.py                                                                                                     4      0   100%
base_python/__init__.py                                                                                                            13      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/airbyte_protocol.py     124      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/__init__.py               1      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/__init__.py                      2      0   100%
base_python/cdk/utils/event_timing.py                                                                                              47      3    94%
base_python/cdk/streams/auth/core.py                                                                                                8      1    88%
base_python/cdk/streams/exceptions.py                                                                                              10      2    80%
base_python/cdk/streams/auth/token.py                                                                                               9      4    56%
base_python/logger.py                                                                                                              33     15    55%
base_python/cdk/streams/rate_limiting.py                                                                                           30     14    53%
base_python/integration.py                                                                                                         52     25    52%
base_python/cdk/streams/http.py                                                                                                    67     33    51%
base_python/cdk/streams/core.py                                                                                                    63     32    49%
base_python/client.py                                                                                                              56     33    41%
base_python/catalog_helpers.py                                                                                                     10      6    40%
base_python/source.py                                                                                                              51     34    33%
base_python/cdk/streams/auth/oauth.py                                                                                              37     26    30%
base_python/cdk/abstract_source.py                                                                                                 89     64    28%
base_python/schema_helpers.py                                                                                                      56     41    27%
base_python/entrypoint.py                                                                                                          70     56    20%
---------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                                             832    389    53%
Name                                                                                                                            Stmts   Miss  Cover
---------------------------------------------------------------------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                                                                                          2      0   100%
normalization/transform_catalog/reserved_keywords.py                                                                               13      0   100%
normalization/transform_catalog/__init__.py                                                                                         2      0   100%
normalization/destination_type.py                                                                                                  13      0   100%
normalization/__init__.py                                                                                                           4      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/airbyte_protocol.py     124      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/__init__.py               1      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/__init__.py                      2      0   100%
normalization/transform_catalog/destination_name_transformer.py                                                                   155      8    95%
normalization/transform_config/transform.py                                                                                       159     30    81%
normalization/transform_catalog/table_name_registry.py                                                                            174     34    80%
normalization/transform_catalog/utils.py                                                                                           33      7    79%
normalization/transform_catalog/catalog_processor.py                                                                              143     77    46%
normalization/transform_catalog/transform.py                                                                                       45     26    42%
normalization/transform_catalog/stream_processor.py                                                                               524    337    36%
---------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                                            1394    519    63%
Name                                                                                                                            Stmts   Miss  Cover
---------------------------------------------------------------------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                                                                                          2      0   100%
normalization/transform_catalog/reserved_keywords.py                                                                               13      0   100%
normalization/transform_catalog/__init__.py                                                                                         2      0   100%
normalization/destination_type.py                                                                                                  13      0   100%
normalization/__init__.py                                                                                                           4      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/airbyte_protocol.py     124      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/__init__.py               1      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/__init__.py                      2      0   100%
normalization/transform_catalog/destination_name_transformer.py                                                                   155      8    95%
normalization/transform_config/transform.py                                                                                       159     30    81%
normalization/transform_catalog/table_name_registry.py                                                                            174     34    80%
normalization/transform_catalog/utils.py                                                                                           33      7    79%
normalization/transform_catalog/catalog_processor.py                                                                              143     77    46%
normalization/transform_catalog/transform.py                                                                                       45     26    42%
normalization/transform_catalog/stream_processor.py                                                                               524    337    36%
---------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                                            1394    519    63%
Name                                                                                                                            Stmts   Miss  Cover
---------------------------------------------------------------------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                                                                                          2      0   100%
normalization/transform_catalog/utils.py                                                                                           33      0   100%
normalization/transform_catalog/reserved_keywords.py                                                                               13      0   100%
normalization/transform_catalog/__init__.py                                                                                         2      0   100%
normalization/destination_type.py                                                                                                  13      0   100%
normalization/__init__.py                                                                                                           4      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/airbyte_protocol.py     124      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/__init__.py               1      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/__init__.py                      2      0   100%
normalization/transform_catalog/destination_name_transformer.py                                                                   155      5    97%
normalization/transform_catalog/stream_processor.py                                                                               524     39    93%
normalization/transform_catalog/catalog_processor.py                                                                              143     12    92%
normalization/transform_catalog/table_name_registry.py                                                                            174     51    71%
normalization/transform_config/transform.py                                                                                       159     52    67%
normalization/transform_catalog/transform.py                                                                                       45     30    33%
---------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                                            1394    189    86%

@edgao edgao marked this pull request as ready for review March 23, 2022 17:00
@edgao edgao requested a review from subodh1810 March 23, 2022 17:00
Comment on lines 117 to 120
# We don't run dbt 1.0.x on all destinations (because their plugins don't support it yet)
# So we need to only pass `--event-buffer-size` if we have DBT 1.0.0
# For some reason, `dbt --version` outputs to stderr, so we need to redirect it to stdout
dbt --version 2>&1 | grep -q 'installed version: 1.0.0'
Copy link
Contributor

Choose a reason for hiding this comment

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

What if we upgrade dbt to 42.2.1?

WHy not just try to run a dummy dbt cli with --event-buffer-size and see if that passes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

42.2.1

I'm not sure what that's referring to, isn't 1.0.x the highest version?

run a dummy dbt cli

I feel like this would take more setup for basically the same outcome? E.g. if it just runs dbt --event-buffer-size=10000 run --project-dir "/nonexistent/path", the script would still need to grep the output (to check whether it failed due to not recognizing --event-buffer-size, or because it just couldn't find the project file)

Unless you're suggesting to try actually running the real command with --event-buffer-size, and if it fails then rerun without it?

Copy link
Contributor

@ChristopheDuong ChristopheDuong Mar 24, 2022

Choose a reason for hiding this comment

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

I'm not sure what that's referring to, isn't 1.0.x the highest version?

Yes today it's the highest, I was just saying when in the future we upgrade dbt again, and the string "1.0.0" being looked for won't be in the output anymore

I feel like this would take more setup for basically the same outcome?

you can do dbt --help
Screenshot 2022-03-24 at 16 49 37

Copy link
Contributor Author

Choose a reason for hiding this comment

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

aaahhh gotcha. yeah this looks a lot nicer, will do!

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Mar 24, 2022
@edgao
Copy link
Contributor Author

edgao commented Mar 24, 2022

/publish connector=bases/base-normalization

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2036599089
❌ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2036599089

@github-actions github-actions bot added area/platform issues related to the platform area/worker Related to worker labels Mar 24, 2022
@edgao edgao temporarily deployed to more-secrets March 24, 2022 21:00 Inactive
@edgao edgao temporarily deployed to more-secrets March 24, 2022 21:01 Inactive
@edgao
Copy link
Contributor Author

edgao commented Mar 24, 2022

looks like the snowflake normalization secret got updated for #11093 - won't be able to publish this branch until that's merged

@ChristopheDuong
Copy link
Contributor

looks like the snowflake normalization secret got updated for #11093 - won't be able to publish this branch until that's merged

Oooooh!! Could that also be why my tests are failing here?

#11294 (comment)

@edgao
Copy link
Contributor Author

edgao commented Mar 25, 2022

yeah, the password field in the config got moved into a sub-object ("credentials": {"password": ...}}) so that's probably the same thing

@edgao
Copy link
Contributor Author

edgao commented Mar 25, 2022

/publish connector=bases/base-normalization

🕑 bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2042115458
✅ bases/base-normalization https://github.com/airbytehq/airbyte/actions/runs/2042115458

@github-actions github-actions bot removed area/platform issues related to the platform area/worker Related to worker labels Mar 25, 2022
@github-actions github-actions bot added area/platform issues related to the platform area/worker Related to worker labels Mar 25, 2022
@edgao edgao temporarily deployed to more-secrets March 25, 2022 22:37 Inactive
@edgao edgao temporarily deployed to more-secrets March 25, 2022 22:37 Inactive
@edgao edgao merged commit 0464a10 into master Mar 25, 2022
@edgao edgao deleted the edgao/dbt_event_buffer_size branch March 25, 2022 23:03

# We don't run dbt 1.0.x on all destinations (because their plugins don't support it yet)
# So we need to only pass `--event-buffer-size` if it's supported by DBT.
dbt --help | grep -E -- '--event-buffer-size'
Copy link
Contributor

Choose a reason for hiding this comment

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

@edgao: If the bundled DBT version in is not supporting the --event-buffer-size flag, the script will exit here because of the previous set -e statement.

This is the case with the MySQL normalization container (normalization-mysql:0.1.74) at the moment, likely the reason why nornalization with MySQL destination currently fails

Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, thanks for pointing that out!

We should probably use this set +e option before calling that line

set +e # allow script to continue running even if next commands fail to run properly

Copy link
Contributor

Choose a reason for hiding this comment

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

opened #11578

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/platform issues related to the platform area/worker Related to worker normalization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants