jedcunningham commented on code in PR #31207: URL: https://github.com/apache/airflow/pull/31207#discussion_r1192917733
########## docs/apache-airflow-providers-pagerduty/notifications/pagerduty_notifier_howto_guide.rst: ########## @@ -0,0 +1,51 @@ + .. 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. + +How-to Guide for Pagerduty notifications +======================================== + +Introduction +------------ +Pagerduty notifier (:class:`airflow.providers.pagerduty.notifications.pagerduty.PagerdutyNotifier`) allows users to send +messages to a pagerduty using the various ``on_*_callbacks`` at both the DAG level and Task level + +Example Code: +------------- + +.. code-block:: python + + from datetime import datetime + from airflow import DAG + from airflow.operators.bash import BashOperator + from airflow.providers.pagerduty.notifications.notifier import send_pagerduty_notification + + with DAG(dag_id="pagerduty_notifier", schedule_interval=None, start_date=datetime(2023, 1, 1), catchup=False): Review Comment: ```suggestion with DAG("pagerduty_notifier", start_date=datetime(2023, 1, 1)): ``` Let's keep it simple. Also, should we have a DAG level example as well? ########## tests/providers/pagerduty/notifications/test_pagerduty.py: ########## @@ -0,0 +1,134 @@ +# 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 __future__ import annotations + +from unittest import mock + +import pytest + +from airflow.models import Connection +from airflow.operators.empty import EmptyOperator +from airflow.providers.pagerduty.hooks.pagerduty_events import PagerdutyEventsHook +from airflow.providers.pagerduty.notifications.pagerduty import ( + PagerdutyNotifier, + send_pagerduty_notification, +) + +PAGERDUTY_API_DEFAULT_CONN_ID = PagerdutyEventsHook.default_conn_name + + [email protected](scope="module", autouse=True) +def pagerduty_api_connections(): Review Comment: I doubt you need this fixture. See #31268 which I just opened. ########## docs/apache-airflow-providers-pagerduty/notifications/pagerduty_notifier_howto_guide.rst: ########## @@ -0,0 +1,51 @@ + .. 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. + +How-to Guide for Pagerduty notifications +======================================== + +Introduction +------------ +Pagerduty notifier (:class:`airflow.providers.pagerduty.notifications.pagerduty.PagerdutyNotifier`) allows users to send +messages to a pagerduty using the various ``on_*_callbacks`` at both the DAG level and Task level + +Example Code: +------------- + +.. code-block:: python + + from datetime import datetime + from airflow import DAG + from airflow.operators.bash import BashOperator + from airflow.providers.pagerduty.notifications.notifier import send_pagerduty_notification + + with DAG(dag_id="pagerduty_notifier", schedule_interval=None, start_date=datetime(2023, 1, 1), catchup=False): + BashOperator( + task_id="mytask", + bash_command="redis-cli ping", Review Comment: ```suggestion bash_command="fail", ``` ########## docs/apache-airflow-providers-pagerduty/notifications/pagerduty_notifier_howto_guide.rst: ########## @@ -0,0 +1,51 @@ + .. 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. + +How-to Guide for Pagerduty notifications +======================================== + +Introduction +------------ +Pagerduty notifier (:class:`airflow.providers.pagerduty.notifications.pagerduty.PagerdutyNotifier`) allows users to send +messages to a pagerduty using the various ``on_*_callbacks`` at both the DAG level and Task level Review Comment: ```suggestion The Pagerduty notifier (:class:`airflow.providers.pagerduty.notifications.pagerduty.PagerdutyNotifier`) allows users to send messages to Pagerduty using the various ``on_*_callbacks`` at both the DAG level and Task level. ``` ########## airflow/providers/pagerduty/notifications/pagerduty.py: ########## @@ -0,0 +1,142 @@ +# 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 __future__ import annotations + +from typing import Any + +from airflow.compat.functools import cached_property +from airflow.exceptions import AirflowOptionalProviderFeatureException + +try: + from airflow.notifications.basenotifier import BaseNotifier +except ImportError: + raise AirflowOptionalProviderFeatureException( + "Failed to import BaseNotifier. This feature is only available in Airflow versions >= 2.6.0" + ) + +from airflow.providers.pagerduty.hooks.pagerduty_events import PagerdutyEventsHook + +ICON_URL: str = "https://raw.githubusercontent.com/apache/airflow/2.5.0/airflow/www/static/pin_100.png"; Review Comment: Is that actually used at all? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
![https://raw.githubusercontent.com/apache/airflow/2.5.0/airflow/www/static/pin_100.png"](https://raw.githubusercontent.com/apache/airflow/2.5.0/airflow/www/static/pin_100.png"){kind=link}