You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/02/01 14:42:42 UTC
[GitHub] [airflow] jithin97 opened a new pull request #7322: [AIRFLOW-6593]
[WIP] Add GCP Stackdriver Alerting Hooks and Operators
jithin97 opened a new pull request #7322: [AIRFLOW-6593] [WIP] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322
### Description
Add GCP Stackdriver Alerting Hooks and Operators
---
Issue link: WILL BE INSERTED BY [boring-cyborg](https://github.com/kaxil/boring-cyborg)
Make sure to mark the boxes below before creating PR: [x]
- [ ] Description above provides context of the change
- [ ] Commit message/PR title starts with `[AIRFLOW-NNNN]`. AIRFLOW-NNNN = JIRA ID<sup>*</sup>
- [ ] Unit tests coverage for changes (not needed for documentation changes)
- [ ] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [ ] Relevant documentation is updated including usage instructions.
- [ ] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
<sup>*</sup> For document-only changes commit message can start with `[AIRFLOW-XXXX]`.
---
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+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 [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] jithin97 commented on a change in pull request #7322:
[AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
jithin97 commented on a change in pull request #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322#discussion_r379713197
##########
File path: airflow/providers/google/cloud/operators/stackdriver.py
##########
@@ -0,0 +1,743 @@
+#
+# 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.
+
+from google.api_core.gapic_v1.method import DEFAULT
+
+from airflow.models import BaseOperator
+from airflow.providers.google.cloud.hooks.stackdriver import StackdriverHook
+from airflow.utils.decorators import apply_defaults
+
+
+class StackdriverListAlertPoliciesOperator(BaseOperator):
+ """
+ Fetches all the Alert Policies identified by the filter passed as
+ filter_ parameter. The desired return type can be specified by the
+ format_ parameter, the supported formats are "dict", "json" and None
+ which returns python dictionary, stringified JSON and protobuf
+ respectively.
+ :param format_: (Optional) Desired output format of the result. The
+ supported formats are "dict", "json" and None which returns
+ python dictionary, stringified JSON and protobuf respectively.
+ :type format_: str
+ :param filter_: If provided, this field specifies the criteria that
+ must be met by alert policies to be included in the response.
+ For more details, see `sorting and filtering
+ <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
+ :type filter_: str
+ :param order_by: A comma-separated list of fields by which to sort the result.
+ Supports the same set of field references as the ``filter`` field. Entries
+ can be prefixed with a minus sign to sort by the field in descending order.
+ For more details, see `sorting and filtering
+ <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
+ :type order_by: str
+ :param page_size: The maximum number of resources contained in the
+ underlying API response. If page streaming is performed per-
+ resource, this parameter does not affect the return value. If page
+ streaming is performed per-page, this determines the maximum number
+ of resources in a page.
+ :type page_size: int
+ :param retry: A retry object used to retry requests. If ``None`` is
+ specified, requests will be retried using a default configuration.
+ :type retry: str
+ :param timeout: The amount of time, in seconds, to wait
+ for the request to complete. Note that if ``retry`` is
+ specified, the timeout applies to each individual attempt.
+ :type timeout: float
+ :param metadata: Additional metadata that is provided to the method.
+ :type metadata: str
+ :param gcp_conn_id: (Optional) The connection ID used to connect to Google
+ Cloud Platform.
+ :type gcp_conn_id: str
+ :param project_id: The project to fetch alerts from.
+ :type project_id: str
+ :param delegate_to: (Optional) The account to impersonate, if any.
+ For this to work, the service account making the request must have
+ domain-wide delegation enabled.
+ :type delegate_to: str
+ """
+
+ template_fields = ('filter_',)
+ ui_color = "#e5ffcc"
+
+ # pylint: disable=too-many-arguments
+ @apply_defaults
+ def __init__(
+ self,
+ format_=None,
+ filter_=None,
+ order_by=None,
+ page_size=None,
+ retry=DEFAULT,
+ timeout=DEFAULT,
+ metadata=None,
+ gcp_conn_id='google_cloud_default',
+ project_id=None,
+ delegate_to=None,
+ *args, **kwargs
+ ):
+ super().__init__(*args, **kwargs)
+ self.format_ = format_
+ self.filter_ = filter_
+ self.order_by = order_by
+ self.page_size = page_size
+ self.retry = retry
+ self.timeout = timeout
+ self.metadata = metadata
+ self.gcp_conn_id = gcp_conn_id
+ self.project_id = project_id
+ self.delegate_to = delegate_to
+ self.hook = None
+
+ def execute(self, context):
+ if self.hook is None:
+ self.hook = StackdriverHook(gcp_conn_id=self.gcp_conn_id, delegate_to=self.delegate_to)
+
+ return self.hook.list_alert_policies(
Review comment:
please check https://github.com/apache/airflow/pull/7322/commits/86898011b3a31e03830d56af567193a6e6d54a2c
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] jithin97 commented on a change in pull request #7322:
[AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
jithin97 commented on a change in pull request #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322#discussion_r379713189
##########
File path: airflow/providers/google/cloud/hooks/stackdriver.py
##########
@@ -0,0 +1,653 @@
+#
+# 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.
+
+"""
+This module contains GCP Stackdriver operators.
+"""
+
+import json
+
+from google.api_core.exceptions import InvalidArgument
+from google.api_core.gapic_v1.method import DEFAULT
+from google.cloud import monitoring_v3
+from google.protobuf.json_format import MessageToDict, MessageToJson, Parse
+from googleapiclient.errors import HttpError
+
+from airflow import AirflowException
+from airflow.providers.google.cloud.hooks.base import CloudBaseHook
+
+
+class StackdriverHook(CloudBaseHook):
+ """
+ Stackdriver Hook for connecting with GCP Stackdriver
+ """
+
+ def __init__(self, gcp_conn_id='google_cloud_default', delegate_to=None):
+ super().__init__(gcp_conn_id, delegate_to)
+ self._policy_client = None
+ self._channel_client = None
+
+ def _get_policy_client(self):
+ if not self._policy_client:
+ self._policy_client = monitoring_v3.AlertPolicyServiceClient()
+ return self._policy_client
+
+ def _get_channel_client(self):
+ if not self._channel_client:
+ self._channel_client = monitoring_v3.NotificationChannelServiceClient()
+ return self._channel_client
+
+ @CloudBaseHook.fallback_to_default_project_id
+ def list_alert_policies(
+ self,
+ project_id=None,
+ format_=None,
+ filter_=None,
+ order_by=None,
+ page_size=None,
+ retry=DEFAULT,
+ timeout=DEFAULT,
+ metadata=None
Review comment:
how about https://github.com/apache/airflow/pull/7322/commits/86898011b3a31e03830d56af567193a6e6d54a2c
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] mik-laj merged pull request #7322: [AIRFLOW-6593] Add GCP
Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
mik-laj merged pull request #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on a change in pull request
#7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322#discussion_r379368245
##########
File path: airflow/providers/google/cloud/operators/stackdriver.py
##########
@@ -0,0 +1,743 @@
+#
+# 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.
+
+from google.api_core.gapic_v1.method import DEFAULT
+
+from airflow.models import BaseOperator
+from airflow.providers.google.cloud.hooks.stackdriver import StackdriverHook
+from airflow.utils.decorators import apply_defaults
+
+
+class StackdriverListAlertPoliciesOperator(BaseOperator):
+ """
+ Fetches all the Alert Policies identified by the filter passed as
+ filter_ parameter. The desired return type can be specified by the
+ format_ parameter, the supported formats are "dict", "json" and None
+ which returns python dictionary, stringified JSON and protobuf
+ respectively.
+ :param format_: (Optional) Desired output format of the result. The
+ supported formats are "dict", "json" and None which returns
+ python dictionary, stringified JSON and protobuf respectively.
+ :type format_: str
+ :param filter_: If provided, this field specifies the criteria that
+ must be met by alert policies to be included in the response.
+ For more details, see `sorting and filtering
+ <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
+ :type filter_: str
+ :param order_by: A comma-separated list of fields by which to sort the result.
+ Supports the same set of field references as the ``filter`` field. Entries
+ can be prefixed with a minus sign to sort by the field in descending order.
+ For more details, see `sorting and filtering
+ <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
+ :type order_by: str
+ :param page_size: The maximum number of resources contained in the
+ underlying API response. If page streaming is performed per-
+ resource, this parameter does not affect the return value. If page
+ streaming is performed per-page, this determines the maximum number
+ of resources in a page.
+ :type page_size: int
+ :param retry: A retry object used to retry requests. If ``None`` is
+ specified, requests will be retried using a default configuration.
+ :type retry: str
+ :param timeout: The amount of time, in seconds, to wait
+ for the request to complete. Note that if ``retry`` is
+ specified, the timeout applies to each individual attempt.
+ :type timeout: float
+ :param metadata: Additional metadata that is provided to the method.
+ :type metadata: str
+ :param gcp_conn_id: (Optional) The connection ID used to connect to Google
+ Cloud Platform.
+ :type gcp_conn_id: str
+ :param project_id: The project to fetch alerts from.
+ :type project_id: str
+ :param delegate_to: (Optional) The account to impersonate, if any.
+ For this to work, the service account making the request must have
+ domain-wide delegation enabled.
+ :type delegate_to: str
+ """
+
+ template_fields = ('filter_',)
+ ui_color = "#e5ffcc"
+
+ # pylint: disable=too-many-arguments
+ @apply_defaults
+ def __init__(
+ self,
+ format_=None,
+ filter_=None,
+ order_by=None,
+ page_size=None,
+ retry=DEFAULT,
+ timeout=DEFAULT,
+ metadata=None,
+ gcp_conn_id='google_cloud_default',
+ project_id=None,
+ delegate_to=None,
+ *args, **kwargs
+ ):
+ super().__init__(*args, **kwargs)
+ self.format_ = format_
+ self.filter_ = filter_
+ self.order_by = order_by
+ self.page_size = page_size
+ self.retry = retry
+ self.timeout = timeout
+ self.metadata = metadata
+ self.gcp_conn_id = gcp_conn_id
+ self.project_id = project_id
+ self.delegate_to = delegate_to
+ self.hook = None
+
+ def execute(self, context):
+ if self.hook is None:
+ self.hook = StackdriverHook(gcp_conn_id=self.gcp_conn_id, delegate_to=self.delegate_to)
+
+ return self.hook.list_alert_policies(
Review comment:
Would it be worth to add some info logging before and after hook call?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] codecov-io commented on issue #7322: [AIRFLOW-6593] Add
GCP Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
codecov-io commented on issue #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322#issuecomment-586569445
# [Codecov](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=h1) Report
> Merging [#7322](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=desc) into [master](https://codecov.io/gh/apache/airflow/commit/edcad79b8d1ee359586c843c6e685cc58d6abacf?src=pr&el=desc) will **decrease** coverage by `0.23%`.
> The diff coverage is `92.95%`.
[](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=tree)
```diff
@@ Coverage Diff @@
## master #7322 +/- ##
==========================================
- Coverage 86.66% 86.42% -0.24%
==========================================
Files 878 881 +3
Lines 41163 41532 +369
==========================================
+ Hits 35673 35896 +223
- Misses 5490 5636 +146
```
| [Impacted Files](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [...ow/providers/google/cloud/operators/stackdriver.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvZ29vZ2xlL2Nsb3VkL29wZXJhdG9ycy9zdGFja2RyaXZlci5weQ==) | `100% <100%> (ø)` | |
| [...s/google/cloud/example\_dags/example\_stackdriver.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvZ29vZ2xlL2Nsb3VkL2V4YW1wbGVfZGFncy9leGFtcGxlX3N0YWNrZHJpdmVyLnB5) | `100% <100%> (ø)` | |
| [...irflow/providers/google/cloud/hooks/stackdriver.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvZ29vZ2xlL2Nsb3VkL2hvb2tzL3N0YWNrZHJpdmVyLnB5) | `81.94% <81.94%> (ø)` | |
| [airflow/kubernetes/volume\_mount.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZV9tb3VudC5weQ==) | `44.44% <0%> (-55.56%)` | :arrow_down: |
| [airflow/kubernetes/volume.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZS5weQ==) | `52.94% <0%> (-47.06%)` | :arrow_down: |
| [airflow/kubernetes/pod\_launcher.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3BvZF9sYXVuY2hlci5weQ==) | `47.18% <0%> (-45.08%)` | :arrow_down: |
| [...viders/cncf/kubernetes/operators/kubernetes\_pod.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvY25jZi9rdWJlcm5ldGVzL29wZXJhdG9ycy9rdWJlcm5ldGVzX3BvZC5weQ==) | `69.38% <0%> (-25.52%)` | :arrow_down: |
| [airflow/kubernetes/refresh\_config.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3JlZnJlc2hfY29uZmlnLnB5) | `50.98% <0%> (-23.53%)` | :arrow_down: |
| [airflow/utils/dag\_processing.py](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree#diff-YWlyZmxvdy91dGlscy9kYWdfcHJvY2Vzc2luZy5weQ==) | `87.93% <0%> (-0.2%)` | :arrow_down: |
| ... and [2 more](https://codecov.io/gh/apache/airflow/pull/7322/diff?src=pr&el=tree-more) | |
------
[Continue to review full report at Codecov](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=footer). Last update [edcad79...5500c77](https://codecov.io/gh/apache/airflow/pull/7322?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on a change in pull request
#7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #7322: [AIRFLOW-6593] Add GCP Stackdriver Alerting Hooks and Operators
URL: https://github.com/apache/airflow/pull/7322#discussion_r379367456
##########
File path: airflow/providers/google/cloud/hooks/stackdriver.py
##########
@@ -0,0 +1,653 @@
+#
+# 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.
+
+"""
+This module contains GCP Stackdriver operators.
+"""
+
+import json
+
+from google.api_core.exceptions import InvalidArgument
+from google.api_core.gapic_v1.method import DEFAULT
+from google.cloud import monitoring_v3
+from google.protobuf.json_format import MessageToDict, MessageToJson, Parse
+from googleapiclient.errors import HttpError
+
+from airflow import AirflowException
+from airflow.providers.google.cloud.hooks.base import CloudBaseHook
+
+
+class StackdriverHook(CloudBaseHook):
+ """
+ Stackdriver Hook for connecting with GCP Stackdriver
+ """
+
+ def __init__(self, gcp_conn_id='google_cloud_default', delegate_to=None):
+ super().__init__(gcp_conn_id, delegate_to)
+ self._policy_client = None
+ self._channel_client = None
+
+ def _get_policy_client(self):
+ if not self._policy_client:
+ self._policy_client = monitoring_v3.AlertPolicyServiceClient()
+ return self._policy_client
+
+ def _get_channel_client(self):
+ if not self._channel_client:
+ self._channel_client = monitoring_v3.NotificationChannelServiceClient()
+ return self._channel_client
+
+ @CloudBaseHook.fallback_to_default_project_id
+ def list_alert_policies(
+ self,
+ project_id=None,
+ format_=None,
+ filter_=None,
+ order_by=None,
+ page_size=None,
+ retry=DEFAULT,
+ timeout=DEFAULT,
+ metadata=None
Review comment:
Would you mind adding type annotations? :)
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services