| |
| |
| <!-- |
| 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>Define an operator extra link — 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="Email Configuration" href="email-config.html" /> |
| <link rel="prev" title="Checking Airflow Health Status" href="check-health.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 current"><a class="reference internal" href="index.html">How-to Guides</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="set-config.html">Setting Configuration Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="initialize-database.html">Initializing a Database Backend</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="operator/index.html">Using Operators</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="custom-operator.html">Creating a custom Operator</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="connection/index.html">Managing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="secure-connections.html">Securing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="secure-connections.html#rotating-encryption-keys">Rotating encryption keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="write-logs.html">Writing Logs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="run-behind-proxy.html">Running Airflow behind a reverse proxy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="run-with-systemd.html">Running Airflow with systemd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="run-with-upstart.html">Running Airflow with upstart</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="use-test-config.html">Using the Test Mode Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="check-health.html">Checking Airflow Health Status</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Define an operator extra link</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#add-or-override-links-to-existing-operators">Add or override Links to Existing Operators</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="email-config.html">Email Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tracking-user-activity.html">Tracking User Activity</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cli-completion.html">Using the Command Line Interface</a></li> |
| </ul> |
| </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"><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">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><a href="index.html">How-to Guides</a> »</li> |
| |
| <li>Define an operator extra link</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../_sources/howto/define_extra_link.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="define-an-operator-extra-link"> |
| <h1>Define an operator extra link<a class="headerlink" href="#define-an-operator-extra-link" title="Permalink to this headline">¶</a></h1> |
| <p>For each operator, you can define its own extra links that can |
| redirect users to external systems. The extra link buttons |
| will be available on the task page:</p> |
| <img alt="../_images/operator_extra_link.png" src="../_images/operator_extra_link.png" /> |
| <p>The following code shows how to add extra links to an operator:</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">airflow.models.baseoperator</span> <span class="kn">import</span> <span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BaseOperatorLink</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="kn">import</span> <span class="n">apply_defaults</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="s1">'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="k">class</span> <span class="nc">MyFirstOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| |
| <span class="n">operator_extra_links</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">GoogleLink</span><span class="p">(),</span> |
| <span class="p">)</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</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">MyFirstOperator</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="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="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>You can also add a global operator extra link that will be available to |
| all the operators through an airflow plugin. Learn more about it in the |
| <a class="reference internal" href="../plugins.html#plugin-example"><span class="std std-ref">plugin example</span></a>.</p> |
| <div class="section" id="add-or-override-links-to-existing-operators"> |
| <h2>Add or override Links to Existing Operators<a class="headerlink" href="#add-or-override-links-to-existing-operators" title="Permalink to this headline">¶</a></h2> |
| <p>You can also add (or override) an extra link to an existing operators |
| through an Airflow plugin.</p> |
| <p>For example, the following Airflow plugin will add an Operator Link on all |
| tasks using <code class="xref py py-class docutils literal notranslate"><span class="pre">GoogleCloudStorageToS3Operator</span></code> operator.</p> |
| <p><strong>Adding Operator Links to Existing Operators</strong> |
| <code class="docutils literal notranslate"><span class="pre">plugins/extra_link.py</span></code>:</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></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.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="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="c1"># Add list of all the operators to which you want to add this OperatorLinks</span> |
| <span class="c1"># Example: operators = [GoogleCloudStorageToS3Operator, GoogleCloudStorageToBigQueryOperator]</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">AirflowExtraLinkPlugin</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">"extra_link_plugin"</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> |
| <p><strong>Overriding Operator Links of Existing Operators</strong>:</p> |
| <p>It is also possible to replace a built in link on an operator via a Plugin. For example |
| <code class="xref py py-class docutils literal notranslate"><span class="pre">BigQueryOperator</span></code> includes a link to the GCP |
| console, but if we wanted to change that link we could:</p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></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.baseoperator</span> <span class="kn">import</span> <span class="n">BaseOperatorLink</span> |
| <span class="kn">from</span> <span class="nn">airflow.gcp.operators.bigquery</span> <span class="kn">import</span> <span class="n">BigQueryOperator</span> |
| |
| <span class="c1"># Change from https to http just to display the override</span> |
| <span class="n">BIGQUERY_JOB_DETAILS_LINK_FMT</span> <span class="o">=</span> <span class="s1">'http://console.cloud.google.com/bigquery?j=</span><span class="si">{job_id}</span><span class="s1">'</span> |
| |
| |
| <span class="k">class</span> <span class="nc">BigQueryConsoleLink</span><span class="p">(</span><span class="n">BaseOperatorLink</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Helper class for constructing BigQuery link.</span> |
| <span class="sd"> """</span> |
| <span class="n">name</span> <span class="o">=</span> <span class="s1">'BigQuery Console'</span> |
| <span class="n">operators</span> <span class="o">=</span> <span class="p">[</span><span class="n">BigQueryOperator</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="n">ti</span> <span class="o">=</span> <span class="n">TaskInstance</span><span class="p">(</span><span class="n">task</span><span class="o">=</span><span class="n">operator</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="n">job_id</span> <span class="o">=</span> <span class="n">ti</span><span class="o">.</span><span class="n">xcom_pull</span><span class="p">(</span><span class="n">task_ids</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">key</span><span class="o">=</span><span class="s1">'job_id'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">BIGQUERY_JOB_DETAILS_LINK_FMT</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">job_id</span><span class="o">=</span><span class="n">job_id</span><span class="p">)</span> <span class="k">if</span> <span class="n">job_id</span> <span class="k">else</span> <span class="s1">''</span> |
| |
| <span class="c1"># Defining the plugin class</span> |
| <span class="k">class</span> <span class="nc">AirflowExtraLinkPlugin</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">"extra_link_plugin"</span> |
| <span class="n">operator_extra_links</span> <span class="o">=</span> <span class="p">[</span><span class="n">BigQueryConsoleLink</span><span class="p">(),</span> <span class="p">]</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="email-config.html" class="btn btn-neutral float-right" title="Email Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="check-health.html" class="btn btn-neutral float-left" title="Checking Airflow Health Status" 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> |
