| |
| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.contrib.operators.opsgenie_alert_operator — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '13']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo --> |
| </head> |
| |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.4 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">API Reference</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.opsgenie_alert_operator</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.operators.opsgenie_alert_operator</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| <span class="c1">#</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.opsgenie_alert_hook</span> <span class="k">import</span> <span class="n">OpsgenieAlertHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> |
| |
| |
| <div class="viewcode-block" id="OpsgenieAlertOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/opsgenie_alert_operator/index.html#airflow.contrib.operators.opsgenie_alert_operator.OpsgenieAlertOperator">[docs]</a><span class="k">class</span> <span class="nc">OpsgenieAlertOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> This operator allows you to post alerts to Opsgenie.</span> |
| <span class="sd"> Accepts a connection that has an Opsgenie API key as the connection's password.</span> |
| <span class="sd"> This operator sets the domain to conn_id.host, and if not set will default</span> |
| <span class="sd"> to ``https://api.opsgenie.com``.</span> |
| |
| <span class="sd"> Each Opsgenie API key can be pre-configured to a team integration.</span> |
| <span class="sd"> You can override these defaults in this operator.</span> |
| |
| <span class="sd"> :param opsgenie_conn_id: The name of the Opsgenie connection to use</span> |
| <span class="sd"> :type opsgenie_conn_id: str</span> |
| <span class="sd"> :param message: The Message of the Opsgenie alert (templated)</span> |
| <span class="sd"> :type message: str</span> |
| <span class="sd"> :param alias: Client-defined identifier of the alert (templated)</span> |
| <span class="sd"> :type alias: str</span> |
| <span class="sd"> :param description: Description field of the alert (templated)</span> |
| <span class="sd"> :type description: str</span> |
| <span class="sd"> :param responders: Teams, users, escalations and schedules that</span> |
| <span class="sd"> the alert will be routed to send notifications.</span> |
| <span class="sd"> :type responders: list[dict]</span> |
| <span class="sd"> :param visibleTo: Teams and users that the alert will become visible</span> |
| <span class="sd"> to without sending any notification.</span> |
| <span class="sd"> :type visibleTo: list[dict]</span> |
| <span class="sd"> :param actions: Custom actions that will be available for the alert.</span> |
| <span class="sd"> :type actions: list[str]</span> |
| <span class="sd"> :param tags: Tags of the alert.</span> |
| <span class="sd"> :type tags: list[str]</span> |
| <span class="sd"> :param details: Map of key-value pairs to use as custom properties of the alert.</span> |
| <span class="sd"> :type details: dict</span> |
| <span class="sd"> :param entity: Entity field of the alert that is</span> |
| <span class="sd"> generally used to specify which domain alert is related to. (templated)</span> |
| <span class="sd"> :type entity: str</span> |
| <span class="sd"> :param source: Source field of the alert. Default value is</span> |
| <span class="sd"> IP address of the incoming request.</span> |
| <span class="sd"> :type source: str</span> |
| <span class="sd"> :param priority: Priority level of the alert. Default value is P3. (templated)</span> |
| <span class="sd"> :type priority: str</span> |
| <span class="sd"> :param user: Display name of the request owner.</span> |
| <span class="sd"> :type user: str</span> |
| <span class="sd"> :param note: Additional note that will be added while creating the alert. (templated)</span> |
| <span class="sd"> :type note: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="OpsgenieAlertOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/opsgenie_alert_operator/index.html#airflow.contrib.operators.opsgenie_alert_operator.OpsgenieAlertOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'message'</span><span class="p">,</span> <span class="s1">'alias'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'entity'</span><span class="p">,</span> <span class="s1">'priority'</span><span class="p">,</span> <span class="s1">'note'</span><span class="p">)</span></div> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">message</span><span class="p">,</span> |
| <span class="n">opsgenie_conn_id</span><span class="o">=</span><span class="s1">'opsgenie_default'</span><span class="p">,</span> |
| <span class="n">alias</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">responders</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">visibleTo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">actions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tags</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">details</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">entity</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">source</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">priority</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">note</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">OpsgenieAlertOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">opsgenie_conn_id</span> <span class="o">=</span> <span class="n">opsgenie_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">alias</span> <span class="o">=</span> <span class="n">alias</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="n">description</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">responders</span> <span class="o">=</span> <span class="n">responders</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">visibleTo</span> <span class="o">=</span> <span class="n">visibleTo</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">actions</span> <span class="o">=</span> <span class="n">actions</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tags</span> <span class="o">=</span> <span class="n">tags</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="n">details</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">entity</span> <span class="o">=</span> <span class="n">entity</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">source</span> <span class="o">=</span> <span class="n">source</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="n">priority</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">note</span> <span class="o">=</span> <span class="n">note</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="OpsgenieAlertOperator._build_opsgenie_payload"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/opsgenie_alert_operator/index.html#airflow.contrib.operators.opsgenie_alert_operator.OpsgenieAlertOperator._build_opsgenie_payload">[docs]</a> <span class="k">def</span> <span class="nf">_build_opsgenie_payload</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Construct the Opsgenie JSON payload. All relevant parameters are combined here</span> |
| <span class="sd"> to a valid Opsgenie JSON payload.</span> |
| |
| <span class="sd"> :return: Opsgenie payload (dict) to send</span> |
| <span class="sd"> """</span> |
| <span class="n">payload</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="p">[</span> |
| <span class="s2">"message"</span><span class="p">,</span> <span class="s2">"alias"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">,</span> <span class="s2">"responders"</span><span class="p">,</span> |
| <span class="s2">"visibleTo"</span><span class="p">,</span> <span class="s2">"actions"</span><span class="p">,</span> <span class="s2">"tags"</span><span class="p">,</span> <span class="s2">"details"</span><span class="p">,</span> <span class="s2">"entity"</span><span class="p">,</span> |
| <span class="s2">"source"</span><span class="p">,</span> <span class="s2">"priority"</span><span class="p">,</span> <span class="s2">"user"</span><span class="p">,</span> <span class="s2">"note"</span> |
| <span class="p">]:</span> |
| <span class="n">val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">val</span><span class="p">:</span> |
| <span class="n">payload</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">val</span> |
| <span class="k">return</span> <span class="n">payload</span></div> |
| |
| <div class="viewcode-block" id="OpsgenieAlertOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/opsgenie_alert_operator/index.html#airflow.contrib.operators.opsgenie_alert_operator.OpsgenieAlertOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Call the OpsgenieAlertHook to post message</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="n">OpsgenieAlertHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">opsgenie_conn_id</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_build_opsgenie_payload</span><span class="p">())</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |