make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

make operator's execution_timeout configurable - #22389

Merged
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout
Apr 11, 2022
Merged

make operator's execution_timeout configurable#22389
potiuk merged 9 commits into
apache:mainfrom
sagmansercan:configurable-execution-timeout

Conversation

@sagmansercan

@sagmansercansagmansercan commented Mar 21, 2022

Copy link
Copy Markdown
Contributor

This PR aims to make the execution_timeout attribute to be configurable globally via airflow.cfg.

  • The default value is still None. Users are expected to
    define an integer value to be passed into timedelta object
    to set the timeout in terms of seconds by default, via configuration.
  • Added gettimedelta method in configuration to be used in abstractoperator
    to get timedelta or None type object. The method raises exceptions
    for the values that are;
    • not convertible to integer
    • too large to be converted to C int.
  • Sample config cases are added into unit tests.

Closes#18578

@boring-cyborg

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@uranusjr

Copy link
Copy Markdown
Member

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Since it is possible to provide a Noneexecution_timeout, the config format also need to support that.

Thanks for the comment, could you provide more details on your suggestion with an example use case?

The default behavior is already None. One can leave this section key empty, or even not define it in its cfg file. This approach tries to cover the "providing None" case with an empty value.

Are you suggesting that the string "None" should also be handled? If so, It would be great to hear what is the difference between "empty string" and "None" is, based on use cases. Additionally, how can we achieve that without explicitly checking if the given string is equal to "None". Also eval does this, but either way both of them do not sound right to me.

Comment threadairflow/configuration.py Outdated
Comment threadairflow/configuration.py Outdated
Comment threadairflow/config_templates/config.yml Outdated
Comment threadairflow/config_templates/config.yml Outdated
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 07da0fc to b28d49cCompareMarch 21, 2022 18:48
Comment threadairflow/configuration.py Outdated
@eladkaleladkal added this to the Airflow 2.3.0 milestone Mar 21, 2022
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from cf91704 to 59b82c3CompareMarch 25, 2022 14:44
Comment threadairflow/configuration.py Outdated
@sagmansercan

Copy link
Copy Markdown
ContributorAuthor

Hi @ashb@eladkal@uranusjr@SamWheating

I've addressed all the comments above, could you please review them again?

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 59b82c3 to 2fcfcd7CompareMarch 29, 2022 10:09
@Bowrna

Copy link
Copy Markdown
Contributor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from 2fcfcd7 to be3b7fdCompareMarch 30, 2022 10:55
@sagmansercan

sagmansercan commented Mar 30, 2022

Copy link
Copy Markdown
ContributorAuthor

@sagmansercan you have to fix the failing static check in the black formatting. Please check.

Thank you for warning @Bowrna, seems like it is related to the black version and fixed in #22598

I will try rebasing and see the result after that because it has not resulted from my changes

Comment threadairflow/configuration.py Outdated
By this commit, execution_timeout attribute of the
operators is now configurable globally via airflow.cfg.
* The default value is still `None`. Users are expected to
define a positive integer value to be passed into timedelta object
to set timeout in terms of seconds by default, via configuration.
* If the key is missing or is set to a non-positive value, then it is
considered as `None`.
* Added `gettimedelta` method to be used in abstractoperator
to get timedelta or None type object. The method raises exception
for the values that are not convertible to integer and/or the values
too large to be converted to C int.
* Sample config cases are added into unit tests.
Closesapache#18578
* By this commit, error raises for the values <= 0
instead of using fallback value
* Updated unit tests
To be more clear to the user, added relevant error message
into to AirflowConfigException.
This parameter specifies the tasks' execution timeout,
so all configuration and variable names are now contains
`task` in it.
fixed the description of default_task_execution_timeout
based on the recent changes
Before this commit, gettimedelta method was preventing
user to provide non-positive values. Now it is totally up to
users to provide a sensible value for this configuration
@sagmansercan
sagmansercanforce-pushed the configurable-execution-timeout branch from be3b7fd to 7f30f25CompareApril 10, 2022 12:46
@github-actions

Copy link
Copy Markdown
Contributor

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actionsgithub-actionsBot added the full tests needed We need to run full set of tests for this PR to merge label Apr 11, 2022
@potiuk
potiuk merged commit a111a79 into apache:mainApr 11, 2022
@boring-cyborg

Copy link
Copy Markdown

Awesome work, congrats on your first merged pull request!

@ephraimbuddyephraimbuddy added the type:new-feature Changelog: New Features label Apr 14, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

full tests neededWe need to run full set of tests for this PR to mergetype:new-featureChangelog: New Features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow to set execution_timeout default value in airflow.cfg

10 participants

@sagmansercan@uranusjr@Bowrna@ashb@potiuk@pingzh@SamWheating@eladkal@ephraimbuddy@sercansagmaninvent