You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "MaksYermak (via GitHub)" <gi...@apache.org> on 2025/09/26 10:51:36 UTC
[PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
MaksYermak opened a new pull request, #56138:
URL: https://github.com/apache/airflow/pull/56138
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
In this PR I have added the `use_rest_api` parameter for `CloudComposerDAGRunSensor`. This parameter can control usage of the Airflow REST API for pulling `dag_runs`. It can be useful for users because the current command for pulling `dag_runs` based on `gcloud`, consumes quota and scales poorly.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #56138:
URL: https://github.com/apache/airflow/pull/56138#discussion_r2382271457
##########
providers/google/src/airflow/providers/google/cloud/hooks/cloud_composer.py:
##########
@@ -472,6 +473,32 @@ def trigger_dag_run(
return response.json()
+ def pull_dag_runs(
Review Comment:
Isn't `get_dag_runs` more appropriate?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "VladaZakharova (via GitHub)" <gi...@apache.org>.
VladaZakharova commented on PR #56138:
URL: https://github.com/apache/airflow/pull/56138#issuecomment-3384981753
@shahar1 Hi there! can you please check this PR? :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "VladaZakharova (via GitHub)" <gi...@apache.org>.
VladaZakharova commented on PR #56138:
URL: https://github.com/apache/airflow/pull/56138#issuecomment-3350881504
@eladkal @potiuk
Can you please check this PR? :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "MaksYermak (via GitHub)" <gi...@apache.org>.
MaksYermak commented on code in PR #56138:
URL: https://github.com/apache/airflow/pull/56138#discussion_r2387228212
##########
providers/google/src/airflow/providers/google/cloud/hooks/cloud_composer.py:
##########
@@ -472,6 +473,32 @@ def trigger_dag_run(
return response.json()
+ def pull_dag_runs(
Review Comment:
@eladkal make sense for me, I have updated the code
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "MaksYermak (via GitHub)" <gi...@apache.org>.
MaksYermak commented on code in PR #56138:
URL: https://github.com/apache/airflow/pull/56138#discussion_r2387230422
##########
providers/google/src/airflow/providers/google/cloud/hooks/cloud_composer.py:
##########
@@ -472,6 +473,32 @@ def trigger_dag_run(
return response.json()
+ def pull_dag_runs(
+ self,
+ composer_airflow_uri: str,
+ composer_dag_id: str,
+ timeout: float | None = None,
+ ) -> dict:
+ """
+ Pull the list of dag runs for provided DAG.
+
+ :param composer_airflow_uri: The URI of the Apache Airflow Web UI hosted within Composer environment.
+ :param composer_dag_id: The ID of DAG.
+ :param timeout: The timeout for this request.
+ """
+ response = self.make_composer_airflow_api_request(
+ method="GET",
+ airflow_uri=composer_airflow_uri,
+ path=f"/api/v1/dags/{composer_dag_id}/dagRuns",
+ timeout=timeout,
+ )
+
+ if response.status_code != 200:
+ self.log.error(response.text)
Review Comment:
@Programmer-RD-AI good point, I have updated the message
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "Programmer-RD-AI (via GitHub)" <gi...@apache.org>.
Programmer-RD-AI commented on code in PR #56138:
URL: https://github.com/apache/airflow/pull/56138#discussion_r2384108602
##########
providers/google/src/airflow/providers/google/cloud/hooks/cloud_composer.py:
##########
@@ -472,6 +473,32 @@ def trigger_dag_run(
return response.json()
+ def pull_dag_runs(
+ self,
+ composer_airflow_uri: str,
+ composer_dag_id: str,
+ timeout: float | None = None,
+ ) -> dict:
+ """
+ Pull the list of dag runs for provided DAG.
+
+ :param composer_airflow_uri: The URI of the Apache Airflow Web UI hosted within Composer environment.
+ :param composer_dag_id: The ID of DAG.
+ :param timeout: The timeout for this request.
+ """
+ response = self.make_composer_airflow_api_request(
+ method="GET",
+ airflow_uri=composer_airflow_uri,
+ path=f"/api/v1/dags/{composer_dag_id}/dagRuns",
+ timeout=timeout,
+ )
+
+ if response.status_code != 200:
+ self.log.error(response.text)
Review Comment:
```suggestion
self.log.error("Failed to pull DAG runs for dag_id=%s from %s (status=%s): %s", composer_dag_id, composer_airflow_uri, response.status_code, response.text)
```
nit: a clearer log message here (including DAG ID, URI, and status) would make failures easier to debug.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add use_rest_api parameter for CloudComposerDAGRunSensor for pulling dag_runs using the Airflow REST API [airflow]
Posted by "shahar1 (via GitHub)" <gi...@apache.org>.
shahar1 merged PR #56138:
URL: https://github.com/apache/airflow/pull/56138
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org