mik-laj commented on a change in pull request #4903: [WIP] [AIRFLOW-4069] Add Opsgenie Alert Hook and Operator URL: https://github.com/apache/airflow/pull/4903#discussion_r264925228
########## File path: airflow/contrib/hooks/opsgenie_alert_hook.py ########## @@ -0,0 +1,173 @@ +# -*- coding: utf-8 -*- +# +# 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. +# + +import json + +from airflow.hooks.http_hook import HttpHook +from airflow.exceptions import AirflowException + + +class OpsgenieAlertHook(HttpHook): + """ + This hook allows you to post alerts to Opsgenie. + Accepts a connection that has an Opsgenie API key as the connection's password. + Each Opsgenie API key can be pre-configured to a team integration. + You can override these defaults in this hook. + + :param http_conn_id: Http connection ID with host as "https://api.opsgenie.com/"; + and Opsgenie API key as the connection's password + (e.g. "eb243592-faa2-4ba2-a551q-1afdf565c889") + :type http_conn_id: str + :param message: The Message of the Opsgenie alert + :type message: str + :param alias: Client-defined identifier of the alert + :type alias: str + :param description: Description field of the alert + :type description: str + :param responders: Teams, users, escalations and schedules that + the alert will be routed to send notifications. + :type responders: list[dict] + :param visible_to: Teams and users that the alert will become visible + to without sending any notification. + :type visible_to: list[dict] + :param actions: Custom actions that will be available for the alert. + :type actions: list[str] + :param tags: Tags of the alert. + :type tags: list[str] + :param details: Map of key-value pairs to use as custom properties of the alert. + :type details: dict + :param entity: Entity field of the alert that is + generally used to specify which domain alert is related to. + :type entity: str + :param source: Source field of the alert. Default value is + IP address of the incoming request. + :type source: str + :param priority: Priority level of the alert. Default value is P3. + :type priority: str + :param user: Display name of the request owner. + :type user: str + :param note: Additional note that will be added while creating the alert. + :type note: str + :param proxy: Proxy to use to make the Opsgenie Alert API call + :type proxy: str + """ + def __init__(self, + http_conn_id=None, + message="", + alias=None, + description=None, + responders=None, + visible_to=None, + actions=None, + tags=None, + details=None, + entity=None, + source=None, + priority=None, + user=None, + note=None, + proxy=None, + *args, + **kwargs + ): + super(OpsgenieAlertHook, self).__init__(*args, **kwargs) + self.http_conn_id = http_conn_id + self.api_key = self._get_api_key(http_conn_id) + self.message = message + self.alias = alias + self.description = description + self.responders = responders + self.visible_to = visible_to + self.actions = actions + self.tags = tags + self.details = details + self.entity = entity + self.source = source + self.priority = priority + self.user = user + self.note = note + self.proxy = proxy + + def _get_api_key(self, http_conn_id): + """ + Given a conn_id, return the api_key to use + :param http_conn_id: The conn_id provided + :type http_conn_id: str + :return: api_key (str) to use + """ + if http_conn_id: + conn = self.get_connection(http_conn_id) + return conn.password + else: + raise AirflowException('Cannot get api_key: No valid conn_id ' + 'supplied') + + def _build_opsgenie_payload(self): + """ + Construct the Opsgenie JSON payload. All relevant parameters are combined here + to a valid Opsgenie JSON payload. + + :return: Opsgenie payload (str) to send + """ + payload = {} + + payload['message'] = self.message + if self.alias: Review comment: Could you create this in loop? ```python for key in ["A".,"B"]: val = getattr(self, key) if val: payload[key] = val ``` Or maybe add a payload parameter to the constructor instead of copying the data? The user will provide data in the appropriate format. The operator will only perform appropriate validation. If it is light, it can be done in the constructor. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
