| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!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>Plugins — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <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/jira-links.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="stylesheet" href="_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/exampleinclude.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Security" href="security.html" /> |
| <link rel="prev" title="Scaling Out with Mesos (community contributed)" href="executor/mesos.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </style> |
| |
| </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.8 |
| </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 class="current"> |
| <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 Reference</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="executor/index.html">Executor</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Plugins</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#what-for">What for?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#why-build-on-top-of-airflow">Why build on top of Airflow?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#interface">Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#example">Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#note-on-role-based-views">Note on role based views</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#plugins-as-python-packages">Plugins as Python packages</a></li> |
| </ul> |
| </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">REST API Reference</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="errors.html">Error Tracking</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="dag-serialization.html">DAG Serialization</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="best-practices.html">Best Practices</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="privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="_api/index.html">Python API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="configurations-ref.html">Configurations</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>Plugins</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/plugins.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <blockquote> |
| <div></div></blockquote> |
| <div class="section" id="plugins"> |
| <h1>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h1> |
| <p>Airflow has a simple plugin manager built-in that can integrate external |
| features to its core by simply dropping files in your |
| <code class="docutils literal notranslate"><span class="pre">$AIRFLOW_HOME/plugins</span></code> folder.</p> |
| <p>The python modules in the <code class="docutils literal notranslate"><span class="pre">plugins</span></code> folder get imported, |
| and <strong>hooks</strong>, <strong>operators</strong>, <strong>sensors</strong>, <strong>macros</strong>, <strong>executors</strong> and web <strong>views</strong> |
| get integrated to Airflow’s main collections and become available for use.</p> |
| <div class="section" id="what-for"> |
| <h2>What for?<a class="headerlink" href="#what-for" title="Permalink to this headline">¶</a></h2> |
| <p>Airflow offers a generic toolbox for working with data. Different |
| organizations have different stacks and different needs. Using Airflow |
| plugins can be a way for companies to customize their Airflow installation |
| to reflect their ecosystem.</p> |
| <p>Plugins can be used as an easy way to write, share and activate new sets of |
| features.</p> |
| <p>There’s also a need for a set of more complex applications to interact with |
| different flavors of data and metadata.</p> |
| <p>Examples:</p> |
| <ul class="simple"> |
| <li><p>A set of tools to parse Hive logs and expose Hive metadata (CPU /IO / phases/ skew /…)</p></li> |
| <li><p>An anomaly detection framework, allowing people to collect metrics, set thresholds and alerts</p></li> |
| <li><p>An auditing tool, helping understand who accesses what</p></li> |
| <li><p>A config-driven SLA monitoring tool, allowing you to set monitored tables and at what time |
| they should land, alert people, and expose visualizations of outages</p></li> |
| <li><p>…</p></li> |
| </ul> |
| </div> |
| <div class="section" id="why-build-on-top-of-airflow"> |
| <h2>Why build on top of Airflow?<a class="headerlink" href="#why-build-on-top-of-airflow" title="Permalink to this headline">¶</a></h2> |
| <p>Airflow has many components that can be reused when building an application:</p> |
| <ul class="simple"> |
| <li><p>A web server you can use to render your views</p></li> |
| <li><p>A metadata database to store your models</p></li> |
| <li><p>Access to your databases, and knowledge of how to connect to them</p></li> |
| <li><p>An array of workers that your application can push workload to</p></li> |
| <li><p>Airflow is deployed, you can just piggy back on its deployment logistics</p></li> |
| <li><p>Basic charting capabilities, underlying libraries and abstractions</p></li> |
| </ul> |
| </div> |
| <div class="section" id="interface"> |
| <h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h2> |
| <p>To create a plugin you will need to derive the |
| <code class="docutils literal notranslate"><span class="pre">airflow.plugins_manager.AirflowPlugin</span></code> class and reference the objects |
| you want to plug into Airflow. Here’s what the class you need to derive |
| looks like:</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">AirflowPlugin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="c1"># The name of your plugin (str)</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="c1"># A list of class(es) derived from BaseOperator</span> |
| <span class="n">operators</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of class(es) derived from BaseSensorOperator</span> |
| <span class="n">sensors</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of class(es) derived from BaseHook</span> |
| <span class="n">hooks</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of class(es) derived from BaseExecutor</span> |
| <span class="n">executors</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of references to inject into the macros namespace</span> |
| <span class="n">macros</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of objects created from a class derived</span> |
| <span class="c1"># from flask_admin.BaseView</span> |
| <span class="n">admin_views</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of Blueprint object created from flask.Blueprint. For use with the flask_admin based GUI</span> |
| <span class="n">flask_blueprints</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of menu links (flask_admin.base.MenuLink). For use with the flask_admin based GUI</span> |
| <span class="n">menu_links</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of dictionaries containing FlaskAppBuilder BaseView object and some metadata. See example below</span> |
| <span class="n">appbuilder_views</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># A list of dictionaries containing FlaskAppBuilder BaseView object and some metadata. See example below</span> |
| <span class="n">appbuilder_menu_items</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="c1"># A list of global operator extra links that can redirect users to</span> |
| <span class="c1"># external systems. These extra links will be available on the</span> |
| <span class="c1"># task page in the form of buttons.</span> |
| <span class="c1">#</span> |
| <span class="c1"># Note: the global operator extra link can be overridden at each</span> |
| <span class="c1"># operator level.</span> |
| <span class="n">global_operator_extra_links</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| |
| <span class="c1"># A list of operator extra links to override or add operator links</span> |
| <span class="c1"># to existing Airflow Operators.</span> |
| <span class="c1"># These extra links will be available on the task page in form of</span> |
| <span class="c1"># buttons.</span> |
| <span class="n">operator_extra_links</span> <span class="o">=</span> <span class="p">[]</span> |
| </pre></div> |
| </div> |
| <p>You can derive it by inheritance (please refer to the example below). |
| Please note <code class="docutils literal notranslate"><span class="pre">name</span></code> inside this class must be specified.</p> |
| <p>After the plugin is imported into Airflow, |
| you can invoke it using statement like</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">airflow.</span><span class="p">{</span><span class="nb">type</span><span class="p">,</span> <span class="n">like</span> <span class="s2">"operators"</span><span class="p">,</span> <span class="s2">"sensors"</span><span class="p">}</span><span class="o">.</span><span class="p">{</span><span class="n">name</span> <span class="n">specificed</span> <span class="n">inside</span> <span class="n">the</span> <span class="n">plugin</span> <span class="n">class</span><span class="p">}</span> <span class="kn">import</span> <span class="o">*</span> |
| </pre></div> |
| </div> |
| <p>When you write your own plugins, make sure you understand them well. |
| There are some essential properties for each type of plugin. |
| For example,</p> |
| <ul class="simple"> |
| <li><p>For <code class="docutils literal notranslate"><span class="pre">Operator</span></code> plugin, an <code class="docutils literal notranslate"><span class="pre">execute</span></code> method is compulsory.</p></li> |
| <li><p>For <code class="docutils literal notranslate"><span class="pre">Sensor</span></code> plugin, a <code class="docutils literal notranslate"><span class="pre">poke</span></code> method returning a Boolean value is compulsory.</p></li> |
| </ul> |
| <p>Make sure you restart the webserver and scheduler after making changes to plugins so that they take effect.</p> |
| </div> |
| <div class="section" id="example"> |
| <span id="plugin-example"></span><h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> |
| <p>The code below defines a plugin that injects a set of dummy object |
| definitions in Airflow.</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># This is the class you derive to create a plugin</span> |
| <span class="kn">from</span> <span class="nn">airflow.plugins_manager</span> <span class="kn">import</span> <span class="n">AirflowPlugin</span> |
| |
| <span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">Blueprint</span> |
| <span class="kn">from</span> <span class="nn">flask_admin</span> <span class="kn">import</span> <span class="n">BaseView</span><span class="p">,</span> <span class="n">expose</span> |
| <span class="kn">from</span> <span class="nn">flask_admin.base</span> <span class="kn">import</span> <span class="n">MenuLink</span> |
| |
| <span class="c1"># Importing base classes that we need to derive</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="kn">import</span> <span class="n">BaseHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="kn">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.models.baseoperator</span> <span class="kn">import</span> <span class="n">BaseOperatorLink</span> |
| <span class="kn">from</span> <span class="nn">airflow.operators.gcs_to_s3</span> <span class="kn">import</span> <span class="n">GoogleCloudStorageToS3Operator</span> |
| <span class="kn">from</span> <span class="nn">airflow.sensors.base_sensor_operator</span> <span class="kn">import</span> <span class="n">BaseSensorOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.executors.base_executor</span> <span class="kn">import</span> <span class="n">BaseExecutor</span> |
| |
| <span class="c1"># Will show up under airflow.hooks.test_plugin.PluginHook</span> |
| <span class="k">class</span> <span class="nc">PluginHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="c1"># Will show up under airflow.operators.test_plugin.PluginOperator</span> |
| <span class="k">class</span> <span class="nc">PluginOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="c1"># Will show up under airflow.sensors.test_plugin.PluginSensorOperator</span> |
| <span class="k">class</span> <span class="nc">PluginSensorOperator</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="c1"># Will show up under airflow.executors.test_plugin.PluginExecutor</span> |
| <span class="k">class</span> <span class="nc">PluginExecutor</span><span class="p">(</span><span class="n">BaseExecutor</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="c1"># Will show up under airflow.macros.test_plugin.plugin_macro</span> |
| <span class="c1"># and in templates through {{ macros.test_plugin.plugin_macro }}</span> |
| <span class="k">def</span> <span class="nf">plugin_macro</span><span class="p">():</span> |
| <span class="k">pass</span> |
| |
| <span class="c1"># Creating a flask admin BaseView</span> |
| <span class="k">class</span> <span class="nc">TestView</span><span class="p">(</span><span class="n">BaseView</span><span class="p">):</span> |
| <span class="nd">@expose</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="c1"># in this example, put your test_plugin/test.html template at airflow/plugins/templates/test_plugin/test.html</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="s2">"test_plugin/test.html"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="s2">"Hello galaxy!"</span><span class="p">)</span> |
| <span class="n">v</span> <span class="o">=</span> <span class="n">TestView</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"Test Plugin"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"Test View"</span><span class="p">)</span> |
| |
| <span class="c1"># Creating a flask blueprint to integrate the templates and static folder</span> |
| <span class="n">bp</span> <span class="o">=</span> <span class="n">Blueprint</span><span class="p">(</span> |
| <span class="s2">"test_plugin"</span><span class="p">,</span> <span class="vm">__name__</span><span class="p">,</span> |
| <span class="n">template_folder</span><span class="o">=</span><span class="s1">'templates'</span><span class="p">,</span> <span class="c1"># registers airflow/plugins/templates as a Jinja template folder</span> |
| <span class="n">static_folder</span><span class="o">=</span><span class="s1">'static'</span><span class="p">,</span> |
| <span class="n">static_url_path</span><span class="o">=</span><span class="s1">'/static/test_plugin'</span><span class="p">)</span> |
| |
| <span class="n">ml</span> <span class="o">=</span> <span class="n">MenuLink</span><span class="p">(</span> |
| <span class="n">category</span><span class="o">=</span><span class="s1">'Test Plugin'</span><span class="p">,</span> |
| <span class="n">name</span><span class="o">=</span><span class="s1">'Test Menu Link'</span><span class="p">,</span> |
| <span class="n">url</span><span class="o">=</span><span class="s1">'https://airflow.apache.org/'</span><span class="p">)</span> |
| |
| <span class="c1"># Creating a flask appbuilder BaseView</span> |
| <span class="k">class</span> <span class="nc">TestAppBuilderBaseView</span><span class="p">(</span><span class="n">AppBuilderBaseView</span><span class="p">):</span> |
| <span class="nd">@expose</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="s2">"test_plugin/test.html"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="s2">"Hello galaxy!"</span><span class="p">)</span> |
| <span class="n">v_appbuilder_view</span> <span class="o">=</span> <span class="n">TestAppBuilderBaseView</span><span class="p">()</span> |
| <span class="n">v_appbuilder_package</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Test View"</span><span class="p">,</span> |
| <span class="s2">"category"</span><span class="p">:</span> <span class="s2">"Test Plugin"</span><span class="p">,</span> |
| <span class="s2">"view"</span><span class="p">:</span> <span class="n">v_appbuilder_view</span><span class="p">}</span> |
| |
| <span class="c1"># Creating a flask appbuilder Menu Item</span> |
| <span class="n">appbuilder_mitem</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Google"</span><span class="p">,</span> |
| <span class="s2">"category"</span><span class="p">:</span> <span class="s2">"Search"</span><span class="p">,</span> |
| <span class="s2">"category_icon"</span><span class="p">:</span> <span class="s2">"fa-th"</span><span class="p">,</span> |
| <span class="s2">"href"</span><span class="p">:</span> <span class="s2">"https://www.google.com"</span><span class="p">}</span> |
| |
| <span class="c1"># A global operator extra link that redirect you to</span> |
| <span class="c1"># task logs stored in S3</span> |
| <span class="k">class</span> <span class="nc">GoogleLink</span><span class="p">(</span><span class="n">BaseOperatorLink</span><span class="p">):</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="s2">"Google"</span> |
| |
| <span class="k">def</span> <span class="nf">get_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">dttm</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s2">"https://www.google.com"</span> |
| |
| <span class="c1"># A list of operator extra links to override or add operator links</span> |
| <span class="c1"># to existing Airflow Operators.</span> |
| <span class="c1"># These extra links will be available on the task page in form of</span> |
| <span class="c1"># buttons.</span> |
| <span class="k">class</span> <span class="nc">S3LogLink</span><span class="p">(</span><span class="n">BaseOperatorLink</span><span class="p">):</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="s1">'S3'</span> |
| <span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">GoogleCloudStorageToS3Operator</span><span class="p">]</span> |
| |
| <span class="k">def</span> <span class="nf">get_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">dttm</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'https://s3.amazonaws.com/airflow-logs/</span><span class="si">{dag_id}</span><span class="s1">/</span><span class="si">{task_id}</span><span class="s1">/</span><span class="si">{execution_date}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">dag_id</span><span class="o">=</span><span class="n">operator</span><span class="o">.</span><span class="n">dag_id</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="n">operator</span><span class="o">.</span><span class="n">task_id</span><span class="p">,</span> |
| <span class="n">execution_date</span><span class="o">=</span><span class="n">dttm</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| |
| <span class="c1"># Defining the plugin class</span> |
| <span class="k">class</span> <span class="nc">AirflowTestPlugin</span><span class="p">(</span><span class="n">AirflowPlugin</span><span class="p">):</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="s2">"test_plugin"</span> |
| <span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">PluginOperator</span><span class="p">]</span> |
| <span class="n">sensors</span> <span class="o">=</span> <span class="p">[</span><span class="n">PluginSensorOperator</span><span class="p">]</span> |
| <span class="n">hooks</span> <span class="o">=</span> <span class="p">[</span><span class="n">PluginHook</span><span class="p">]</span> |
| <span class="n">executors</span> <span class="o">=</span> <span class="p">[</span><span class="n">PluginExecutor</span><span class="p">]</span> |
| <span class="n">macros</span> <span class="o">=</span> <span class="p">[</span><span class="n">plugin_macro</span><span class="p">]</span> |
| <span class="n">admin_views</span> <span class="o">=</span> <span class="p">[</span><span class="n">v</span><span class="p">]</span> |
| <span class="n">flask_blueprints</span> <span class="o">=</span> <span class="p">[</span><span class="n">bp</span><span class="p">]</span> |
| <span class="n">menu_links</span> <span class="o">=</span> <span class="p">[</span><span class="n">ml</span><span class="p">]</span> |
| <span class="n">appbuilder_views</span> <span class="o">=</span> <span class="p">[</span><span class="n">v_appbuilder_package</span><span class="p">]</span> |
| <span class="n">appbuilder_menu_items</span> <span class="o">=</span> <span class="p">[</span><span class="n">appbuilder_mitem</span><span class="p">]</span> |
| <span class="n">global_operator_extra_links</span> <span class="o">=</span> <span class="p">[</span><span class="n">GoogleLink</span><span class="p">(),]</span> |
| <span class="n">operator_extra_links</span> <span class="o">=</span> <span class="p">[</span><span class="n">S3LogLink</span><span class="p">(),</span> <span class="p">]</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="note-on-role-based-views"> |
| <h2>Note on role based views<a class="headerlink" href="#note-on-role-based-views" title="Permalink to this headline">¶</a></h2> |
| <p>Airflow 1.10 introduced role based views using FlaskAppBuilder. You can configure which UI is used by setting |
| <code class="docutils literal notranslate"><span class="pre">rbac</span> <span class="pre">=</span> <span class="pre">True</span></code>. To support plugin views and links for both versions of the UI and maintain backwards compatibility, |
| the fields <code class="docutils literal notranslate"><span class="pre">appbuilder_views</span></code> and <code class="docutils literal notranslate"><span class="pre">appbuilder_menu_items</span></code> were added to the <code class="docutils literal notranslate"><span class="pre">AirflowTestPlugin</span></code> class.</p> |
| </div> |
| <div class="section" id="plugins-as-python-packages"> |
| <h2>Plugins as Python packages<a class="headerlink" href="#plugins-as-python-packages" title="Permalink to this headline">¶</a></h2> |
| <p>It is possible to load plugins via <a class="reference external" href="https://packaging.python.org/guides/creating-and-discovering-plugins/#using-package-metadata">setuptools entrypoint</a> mechanism. To do this link |
| your plugin using an entrypoint in your package. If the package is installed, airflow |
| will automatically load the registered plugins from the entrypoint list.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Neither the entrypoint name (eg, <code class="docutils literal notranslate"><span class="pre">my_plugin</span></code>) nor the name of the |
| plugin class will contribute towards the module and class name of the plugin |
| itself. The structure is determined by |
| <code class="docutils literal notranslate"><span class="pre">airflow.plugins_manager.AirflowPlugin.name</span></code> and the class name of the plugin |
| component with the pattern <code class="docutils literal notranslate"><span class="pre">airflow.{component}.{name}.{component_class_name}</span></code>.</p> |
| </div> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># my_package/my_plugin.py</span> |
| <span class="kn">from</span> <span class="nn">airflow.plugins_manager</span> <span class="kn">import</span> <span class="n">AirflowPlugin</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="kn">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="kn">import</span> <span class="n">BaseHook</span> |
| |
| <span class="k">class</span> <span class="nc">MyOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="k">class</span> <span class="nc">MyHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="k">class</span> <span class="nc">MyAirflowPlugin</span><span class="p">(</span><span class="n">AirflowPlugin</span><span class="p">):</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="s1">'my_namespace'</span> |
| <span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">MyOperator</span><span class="p">]</span> |
| <span class="n">hooks</span> <span class="o">=</span> <span class="p">[</span><span class="n">MyHook</span><span class="p">]</span> |
| </pre></div> |
| </div> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">setuptools</span> <span class="kn">import</span> <span class="n">setup</span> |
| |
| <span class="n">setup</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="s2">"my-package"</span><span class="p">,</span> |
| <span class="o">...</span> |
| <span class="n">entry_points</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'airflow.plugins'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s1">'my_plugin = my_package.my_plugin:MyAirflowPlugin'</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <dl class="simple"> |
| <dt>This will create a hook, and an operator accessible at:</dt><dd><ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">airflow.hooks.my_namespace.MyHook</span></code></p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">airflow.operators.my_namespace.MyOperator</span></code></p></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="security.html" class="btn btn-neutral float-right" title="Security" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="executor/mesos.html" class="btn btn-neutral float-left" title="Scaling Out with Mesos (community contributed)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <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>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="privacy_notice.html">Privacy Policy</a> |
| for more details. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |
