Taragolis commented on code in PR #35530: URL: https://github.com/apache/airflow/pull/35530#discussion_r1388469452
########## tests/system/providers/opsgenie/example_opsgenie_notifier.py: ########## @@ -0,0 +1,38 @@ +# 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 +from datetime import datetime +from airflow import DAG +from airflow.operators.bash import BashOperator +from airflow.providers.opsgenie.notifications.opsgenie import send_opsgenie_notification + +with DAG( + "opsgenie_notifier", + start_date=datetime(2023, 1, 1), + on_failure_callback=[ + send_opsgenie_notification( + message="Something went wrong!" + ) + ], +): + BashOperator( + task_id="mytask", + bash_command="fail", + on_failure_callback=[ + send_opsgenie_notification( + message="Something went wrong!" + ) + ], + ) Review Comment: ```suggestion ) # [END howto_notifier_opsgenie] from tests.system.utils import get_test_run # noqa: E402 # Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest) test_run = get_test_run(dag) ``` ########## docs/apache-airflow-providers-opsgenie/notifications/opsgenie_notifier.rst: ########## @@ -0,0 +1,31 @@ + .. 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. + +.. _howto/notifier:OpsgenieNotifier: + +OpsgenieNotifier +=========================== + +Use the :class:`~airflow.providers.opsgenie.notifications.opsgenie.OpsgenieNotifier` to send an alert to opsgenie. + + +Using the Notifier +^^^^^^^^^^^^^^^^^^ +Send an alert to Opsgenie with a specific message. + +.. exampleinclude:: /../../../tests/system/providers/opsgenie/example_opsgenie_notifier.py Review Comment: ```suggestion .. exampleinclude:: /../../tests/system/providers/opsgenie/example_opsgenie_notifier.py :language: python :start-after: [START howto_notifier_opsgenie] :end-before: [END howto_notifier_opsgenie] ``` ########## tests/system/providers/opsgenie/example_opsgenie_notifier.py: ########## @@ -0,0 +1,38 @@ +# 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 +from datetime import datetime Review Comment: ```suggestion # [START howto_notifier_opsgenie] from datetime import datetime ``` ########## docs/apache-airflow-providers-opsgenie/notifications/index.rst: ########## @@ -0,0 +1,26 @@ + .. 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. + + + +Opsgenie Notifiers +==================== + +.. toctree:: + :maxdepth: 1 + + opsgenie_notifier Review Comment: ```suggestion :glob: * ``` ########## docs/apache-airflow-providers-opsgenie/notifications/index.rst: ########## @@ -0,0 +1,26 @@ + .. 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. + + + +Opsgenie Notifiers +==================== + Review Comment: ```suggestion .. important:: This feature is only available in Airflow versions >= 2.6.0 ``` -- 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]
