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

Add timeout parameter to druid operator so it can be used in hook #19984

Merged

Conversation

piotrkmita
Copy link
Contributor

Hello!

We've started using that DruidOperator few weeks ago. We've realized that the DruidHook used there is calling druid overlord every 1 second to get status, because it's using default timeout and it's not possible to set it in the operator itself. In our case ingestion takes around 1 hour, so there is no need to check it that often.

Example log:
image

We would would like to add timeout parameter to DruidOperator, so we can set how often DruidHook will be calling overlord to get status.

Example log after change with timeout 180 seconds:
image

Please let me know if I've missed something.
Thank you!


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

@boring-cyborg
Copy link

boring-cyborg bot commented Dec 2, 2021

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@potiuk
Copy link
Member

potiuk commented Dec 2, 2021

I think you should add/modify unit tests for the hook. Happy to Approve & Run them if you add them @piotrkmita

@piotrkmita
Copy link
Contributor Author

Hey @potiuk
thank you for your suggestion. I've updated the test_submit_timeout to have timeout=5, so status will be called at times 0, 5, 10 and check if status_check.call_count is equal 3. Also, created one more checking if default timeout is working properly if it's not set.

Does it make sense or have you meant something else?
Thanks!

@potiuk
Copy link
Member

potiuk commented Dec 3, 2021

I thought more about adding a test to tests/apache/druid/operators/test_druid.py not hooks/test_druid.py - to add instantiation of the operator with timout passed as parameter.

@piotrkmita
Copy link
Contributor Author

piotrkmita commented Dec 5, 2021

I reverted previous commit and added tests for timeout and max_ingestion_time.
Please let me know if I should improve something.
Thank you!

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Dec 5, 2021
@github-actions
Copy link

github-actions bot commented Dec 5, 2021

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@@ -23,6 23,7 @@
from airflow.utils.types import DagRunType

DEFAULT_DATE = timezone.datetime(2017, 1, 1)
DEFAULT_TIMEOUT = 1
Copy link
Member

Choose a reason for hiding this comment

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

This seems unnecessary? If you want a constant, you should probably put it in the provider code instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've replaced it with variable in the test. Is it fine now?

@eladkal eladkal merged commit c1bbe3c into apache:main Dec 21, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 21, 2021

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers okay to merge It's ok to merge this PR as it does not require more tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants