blob: 6e181db999f1e30251f0354eaad3c3581bd07a57 [file] [log] [blame]
<!--
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>Dingding Operators &mdash; 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="Google Cloud Operators" href="gcp/index.html" />
<link rel="prev" title="BashOperator" href="bash.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 current"><a class="reference internal" href="index.html">Using Operators</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="bash.html">BashOperator</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Dingding Operators</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#prerequisite-tasks">Prerequisite Tasks</a></li>
<li class="toctree-l4"><a class="reference internal" href="#basic-usage">Basic Usage</a></li>
<li class="toctree-l4"><a class="reference internal" href="#remind-users-in-message">Remind users in message</a></li>
<li class="toctree-l4"><a class="reference internal" href="#send-rich-text-message">Send rich text message</a></li>
<li class="toctree-l4"><a class="reference internal" href="#sending-messages-from-a-task-callback">Sending messages from a Task callback</a></li>
<li class="toctree-l4"><a class="reference internal" href="#changing-connection-host-if-you-need">Changing connection host if you need</a></li>
<li class="toctree-l4"><a class="reference internal" href="#more-information">More information</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gcp/index.html">Google Cloud Operators</a></li>
<li class="toctree-l3"><a class="reference internal" href="papermill.html">Papermill</a></li>
<li class="toctree-l3"><a class="reference internal" href="python.html">PythonOperator</a></li>
<li class="toctree-l3"><a class="reference internal" href="external.html">Cross-DAG Dependencies</a></li>
</ul>
</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"><a class="reference internal" href="../define_extra_link.html">Define an operator extra link</a></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 &amp; 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> &raquo;</li>
<li><a href="../index.html">How-to Guides</a> &raquo;</li>
<li><a href="index.html">Using Operators</a> &raquo;</li>
<li>Dingding Operators</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/howto/operator/dingding.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="dingding-operators">
<h1>Dingding Operators<a class="headerlink" href="#dingding-operators" title="Permalink to this headline"></a></h1>
<div class="section" id="prerequisite-tasks">
<h2>Prerequisite Tasks<a class="headerlink" href="#prerequisite-tasks" title="Permalink to this headline"></a></h2>
<p>To use this operators, you must do a few things:</p>
<blockquote>
<div><ul class="simple">
<li><p>Add custom robot to Dingding group which you want to send Dingding message.</p></li>
<li><p>Get the webhook token from Dingding custom robot.</p></li>
<li><p>Put the Dingding custom robot token in the password field of the <code class="docutils literal notranslate"><span class="pre">dingding_default</span></code>
Connection. Notice that you just need token rather than the whole webhook string.</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="basic-usage">
<h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline"></a></h2>
<p>Use the <code class="xref py py-class docutils literal notranslate"><span class="pre">DingdingOperator</span></code>
to send Dingding message:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_dingding_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../_modules/airflow/contrib/example_dags/example_dingding_operator.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">text_msg_remind_none</span> <span class="o">=</span> <span class="n">DingdingOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;text_msg_remind_none&#39;</span><span class="p">,</span>
<span class="n">dingding_conn_id</span><span class="o">=</span><span class="s1">&#39;dingding_default&#39;</span><span class="p">,</span>
<span class="n">message_type</span><span class="o">=</span><span class="s1">&#39;text&#39;</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s1">&#39;Airflow dingding text message remind none&#39;</span><span class="p">,</span>
<span class="n">at_mobiles</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">at_all</span><span class="o">=</span><span class="kc">False</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="remind-users-in-message">
<h2>Remind users in message<a class="headerlink" href="#remind-users-in-message" title="Permalink to this headline"></a></h2>
<p>Use parameters <code class="docutils literal notranslate"><span class="pre">at_mobiles</span></code> and <code class="docutils literal notranslate"><span class="pre">at_all</span></code> to remind specific users when you send message,
<code class="docutils literal notranslate"><span class="pre">at_mobiles</span></code> will be ignored When <code class="docutils literal notranslate"><span class="pre">at_all</span></code> is set to <code class="docutils literal notranslate"><span class="pre">True</span></code>:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_dingding_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../_modules/airflow/contrib/example_dags/example_dingding_operator.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">text_msg_remind_all</span> <span class="o">=</span> <span class="n">DingdingOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;text_msg_remind_all&#39;</span><span class="p">,</span>
<span class="n">dingding_conn_id</span><span class="o">=</span><span class="s1">&#39;dingding_default&#39;</span><span class="p">,</span>
<span class="n">message_type</span><span class="o">=</span><span class="s1">&#39;text&#39;</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s1">&#39;Airflow dingding text message remind all users in group&#39;</span><span class="p">,</span>
<span class="c1"># list of user phone/email here in the group</span>
<span class="c1"># when at_all is specific will cover at_mobiles</span>
<span class="n">at_mobiles</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;156XXXXXXXX&#39;</span><span class="p">,</span> <span class="s1">&#39;130XXXXXXXX&#39;</span><span class="p">],</span>
<span class="n">at_all</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="send-rich-text-message">
<h2>Send rich text message<a class="headerlink" href="#send-rich-text-message" title="Permalink to this headline"></a></h2>
<p>The Dingding operator can send rich text messages including link, markdown, actionCard and feedCard.
A rich text message can not remind specific users except by using markdown type message:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_dingding_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../_modules/airflow/contrib/example_dags/example_dingding_operator.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">markdown_msg</span> <span class="o">=</span> <span class="n">DingdingOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;markdown_msg&#39;</span><span class="p">,</span>
<span class="n">dingding_conn_id</span><span class="o">=</span><span class="s1">&#39;dingding_default&#39;</span><span class="p">,</span>
<span class="n">message_type</span><span class="o">=</span><span class="s1">&#39;markdown&#39;</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="p">{</span>
<span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39;Airflow dingding markdown message&#39;</span><span class="p">,</span>
<span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="s1">&#39;# Markdown message title</span><span class="se">\n</span><span class="s1">&#39;</span>
<span class="s1">&#39;content content .. </span><span class="se">\n</span><span class="s1">&#39;</span>
<span class="s1">&#39;### sub-title</span><span class="se">\n</span><span class="s1">&#39;</span>
<span class="s1">&#39;![logo](http://airflow.apache.org/_images/pin_large.png)&#39;</span>
<span class="p">},</span>
<span class="n">at_mobiles</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;156XXXXXXXX&#39;</span><span class="p">],</span>
<span class="n">at_all</span><span class="o">=</span><span class="kc">False</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="sending-messages-from-a-task-callback">
<h2>Sending messages from a Task callback<a class="headerlink" href="#sending-messages-from-a-task-callback" title="Permalink to this headline"></a></h2>
<p>Dingding operator could handle task callback by writing a function wrapper dingding operators
and then pass the function to <code class="docutils literal notranslate"><span class="pre">sla_miss_callback</span></code>, <code class="docutils literal notranslate"><span class="pre">on_success_callback</span></code>, <code class="docutils literal notranslate"><span class="pre">on_failure_callback</span></code>,
or <code class="docutils literal notranslate"><span class="pre">on_retry_callback</span></code>. Here we use <code class="docutils literal notranslate"><span class="pre">on_failure_callback</span></code> as an example:</p>
<div class="example-block-wrapper docutils container">
<p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_dingding_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../_modules/airflow/contrib/example_dags/example_dingding_operator.html"><span>View Source</span></a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">failure_callback</span><span class="p">(</span><span class="n">context</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The function that will be executed on failure.</span>
<span class="sd"> :param context: The context of the executed task.</span>
<span class="sd"> :type context: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;AIRFLOW TASK FAILURE TIPS:</span><span class="se">\n</span><span class="s1">&#39;</span> \
<span class="s1">&#39;DAG: </span><span class="si">{}</span><span class="se">\n</span><span class="s1">&#39;</span> \
<span class="s1">&#39;TASKS: </span><span class="si">{}</span><span class="se">\n</span><span class="s1">&#39;</span> \
<span class="s1">&#39;Reason: </span><span class="si">{}</span><span class="se">\n</span><span class="s1">&#39;</span> \
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">context</span><span class="p">[</span><span class="s1">&#39;task_instance&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">dag_id</span><span class="p">,</span>
<span class="n">context</span><span class="p">[</span><span class="s1">&#39;task_instance&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">task_id</span><span class="p">,</span>
<span class="n">context</span><span class="p">[</span><span class="s1">&#39;exception&#39;</span><span class="p">])</span>
<span class="k">return</span> <span class="n">DingdingOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s1">&#39;dingding_success_callback&#39;</span><span class="p">,</span>
<span class="n">dingding_conn_id</span><span class="o">=</span><span class="s1">&#39;dingding_default&#39;</span><span class="p">,</span>
<span class="n">message_type</span><span class="o">=</span><span class="s1">&#39;text&#39;</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">,</span>
<span class="n">at_all</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
<span class="n">args</span><span class="p">[</span><span class="s1">&#39;on_failure_callback&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">failure_callback</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="changing-connection-host-if-you-need">
<h2>Changing connection host if you need<a class="headerlink" href="#changing-connection-host-if-you-need" title="Permalink to this headline"></a></h2>
<p>The Dingding operator post http requests using default host <code class="docutils literal notranslate"><span class="pre">https://oapi.dingtalk.com</span></code>,
if you need to change the host used you can set the host field of the connection.</p>
</div>
<div class="section" id="more-information">
<h2>More information<a class="headerlink" href="#more-information" title="Permalink to this headline"></a></h2>
<p>See Dingding documentation on how to <a class="reference external" href="https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq">custom robot</a>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="gcp/index.html" class="btn btn-neutral float-right" title="Google Cloud Operators" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="bash.html" class="btn btn-neutral float-left" title="BashOperator" 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>