docs-archive/apache-airflow/1.10.2/metrics.html - airflow-site - Git at Google



 <!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>Metrics &mdash; Airflow Documentation</title>


   <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" />
     <link rel="next" title="Kubernetes" href="kubernetes.html" />
     <link rel="prev" title="Integration" href="integration.html" />


   <script src="_static/js/modernizr.min.js"></script>
 <!-- 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 -->
 <link rel="canonical" href="https://airflow.apache.org/docs/apache-airflow/stable/metrics.html" />
 </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.2
               </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</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="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 current"><a class="current reference internal" href="#">Metrics</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#counters">Counters</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#gauges">Gauges</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#timers">Timers</a></li>
 </ul>
 </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="code.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> &raquo;</li>

       <li>Metrics</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/metrics.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">

   <div class="section" id="metrics">
 <h1>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="configuration">
 <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
 <p>Airflow can be set up to send metrics to <a class="reference external" href="https://github.com/etsy/statsd">StatsD</a>:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>scheduler<span class="o">]</span>
 <span class="nv">statsd_on</span> <span class="o">=</span> True
 <span class="nv">statsd_host</span> <span class="o">=</span> localhost
 <span class="nv">statsd_port</span> <span class="o">=</span> <span class="m">8125</span>
 <span class="nv">statsd_prefix</span> <span class="o">=</span> airflow
 </pre></div>
 </div>
 </div>
 <div class="section" id="counters">
 <h2>Counters<a class="headerlink" href="#counters" title="Permalink to this headline">¶</a></h2>
 <table border="1" class="docutils">
 <colgroup>
 <col width="35%" />
 <col width="65%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">Name</th>
 <th class="head">Description</th>
 </tr>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>&lt;job_name&gt;_start</td>
 <td>Number of started &lt;job_name&gt; job, ex. SchedulerJob, LocalTaskJob</td>
 </tr>
 <tr class="row-odd"><td>&lt;job_name&gt;_end</td>
 <td>Number of ended &lt;job_name&gt; job, ex. SchedulerJob, LocalTaskJob</td>
 </tr>
 <tr class="row-even"><td>operator_failures_&lt;operator_name&gt;</td>
 <td>Operator &lt;operator_name&gt; failures</td>
 </tr>
 <tr class="row-odd"><td>operator_successes_&lt;operator_name&gt;</td>
 <td>Operator &lt;operator_name&gt; successes</td>
 </tr>
 <tr class="row-even"><td>ti_failures</td>
 <td>Overall task instances failures</td>
 </tr>
 <tr class="row-odd"><td>ti_successes</td>
 <td>Overall task instances successes</td>
 </tr>
 <tr class="row-even"><td>zombies_killed</td>
 <td>Zombie tasks killed</td>
 </tr>
 <tr class="row-odd"><td>scheduler_heartbeat</td>
 <td>Scheduler heartbeats</td>
 </tr>
 </tbody>
 </table>
 </div>
 <div class="section" id="gauges">
 <h2>Gauges<a class="headerlink" href="#gauges" title="Permalink to this headline">¶</a></h2>
 <table border="1" class="docutils">
 <colgroup>
 <col width="36%" />
 <col width="64%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">Name</th>
 <th class="head">Description</th>
 </tr>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>collect_dags</td>
 <td>Seconds taken to scan and import DAGs</td>
 </tr>
 <tr class="row-odd"><td>dagbag_import_errors</td>
 <td>DAG import errors</td>
 </tr>
 <tr class="row-even"><td>dagbag_size</td>
 <td>DAG bag size</td>
 </tr>
 </tbody>
 </table>
 </div>
 <div class="section" id="timers">
 <h2>Timers<a class="headerlink" href="#timers" title="Permalink to this headline">¶</a></h2>
 <table border="1" class="docutils">
 <colgroup>
 <col width="46%" />
 <col width="54%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">Name</th>
 <th class="head">Description</th>
 </tr>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>dagrun.dependency-check.&lt;dag_id&gt;</td>
 <td>Seconds taken to check DAG dependencies</td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="kubernetes.html" class="btn btn-neutral float-right" title="Kubernetes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="integration.html" class="btn btn-neutral" title="Integration" 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>.

 </footer>

         </div>
       </div>

     </section>

   </div>


       <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>

   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>

 </body>
 </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>Metrics — Airflow Documentation</title>















	<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" />
	<link rel="next" title="Kubernetes" href="kubernetes.html" />
	<link rel="prev" title="Integration" href="integration.html" />


	<script src="_static/js/modernizr.min.js"></script>
	<!-- 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 -->
	<link rel="canonical" href="https://airflow.apache.org/docs/apache-airflow/stable/metrics.html" />
	</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.2
	</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</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 current"><a class="current reference internal" href="#">Metrics</a><ul>
	<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
	<li class="toctree-l2"><a class="reference internal" href="#counters">Counters</a></li>
	<li class="toctree-l2"><a class="reference internal" href="#gauges">Gauges</a></li>
	<li class="toctree-l2"><a class="reference internal" href="#timers">Timers</a></li>
	</ul>
	</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="code.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>Metrics</li>


	<li class="wy-breadcrumbs-aside">


	<a href="_sources/metrics.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">

	<div class="section" id="metrics">
	<h1>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h1>
	<div class="section" id="configuration">
	<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
	<p>Airflow can be set up to send metrics to <a class="reference external" href="https://github.com/etsy/statsd">StatsD</a>:</p>
	<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>scheduler<span class="o">]</span>
	<span class="nv">statsd_on</span> <span class="o">=</span> True
	<span class="nv">statsd_host</span> <span class="o">=</span> localhost
	<span class="nv">statsd_port</span> <span class="o">=</span> <span class="m">8125</span>
	<span class="nv">statsd_prefix</span> <span class="o">=</span> airflow
	</pre></div>
	</div>
	</div>
	<div class="section" id="counters">
	<h2>Counters<a class="headerlink" href="#counters" title="Permalink to this headline">¶</a></h2>
	<table border="1" class="docutils">
	<colgroup>
	<col width="35%" />
	<col width="65%" />
	</colgroup>
	<thead valign="bottom">
	<tr class="row-odd"><th class="head">Name</th>
	<th class="head">Description</th>
	</tr>
	</thead>
	<tbody valign="top">
	<tr class="row-even"><td><job_name>_start</td>
	<td>Number of started <job_name> job, ex. SchedulerJob, LocalTaskJob</td>
	</tr>
	<tr class="row-odd"><td><job_name>_end</td>
	<td>Number of ended <job_name> job, ex. SchedulerJob, LocalTaskJob</td>
	</tr>
	<tr class="row-even"><td>operator_failures_<operator_name></td>
	<td>Operator <operator_name> failures</td>
	</tr>
	<tr class="row-odd"><td>operator_successes_<operator_name></td>
	<td>Operator <operator_name> successes</td>
	</tr>
	<tr class="row-even"><td>ti_failures</td>
	<td>Overall task instances failures</td>
	</tr>
	<tr class="row-odd"><td>ti_successes</td>
	<td>Overall task instances successes</td>
	</tr>
	<tr class="row-even"><td>zombies_killed</td>
	<td>Zombie tasks killed</td>
	</tr>
	<tr class="row-odd"><td>scheduler_heartbeat</td>
	<td>Scheduler heartbeats</td>
	</tr>
	</tbody>
	</table>
	</div>
	<div class="section" id="gauges">
	<h2>Gauges<a class="headerlink" href="#gauges" title="Permalink to this headline">¶</a></h2>
	<table border="1" class="docutils">
	<colgroup>
	<col width="36%" />
	<col width="64%" />
	</colgroup>
	<thead valign="bottom">
	<tr class="row-odd"><th class="head">Name</th>
	<th class="head">Description</th>
	</tr>
	</thead>
	<tbody valign="top">
	<tr class="row-even"><td>collect_dags</td>
	<td>Seconds taken to scan and import DAGs</td>
	</tr>
	<tr class="row-odd"><td>dagbag_import_errors</td>
	<td>DAG import errors</td>
	</tr>
	<tr class="row-even"><td>dagbag_size</td>
	<td>DAG bag size</td>
	</tr>
	</tbody>
	</table>
	</div>
	<div class="section" id="timers">
	<h2>Timers<a class="headerlink" href="#timers" title="Permalink to this headline">¶</a></h2>
	<table border="1" class="docutils">
	<colgroup>
	<col width="46%" />
	<col width="54%" />
	</colgroup>
	<thead valign="bottom">
	<tr class="row-odd"><th class="head">Name</th>
	<th class="head">Description</th>
	</tr>
	</thead>
	<tbody valign="top">
	<tr class="row-even"><td>dagrun.dependency-check.<dag_id></td>
	<td>Seconds taken to check DAG dependencies</td>
	</tr>
	</tbody>
	</table>
	</div>
	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="kubernetes.html" class="btn btn-neutral float-right" title="Kubernetes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="integration.html" class="btn btn-neutral" title="Integration" 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>.

	</footer>

	</div>
	</div>

	</section>

	</div>







	<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>

	<script type="text/javascript">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>

	</body>
	</html>