| |
| |
| |
| |
| |
| <!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> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Kubernetes" href="kubernetes.html" /> |
| <link rel="prev" title="Integration" href="integration.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </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.5 |
| </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="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 current"><a class="current reference internal" href="#">Metrics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#setup">Setup</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="macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="privacy_notice.html">Privacy Notice</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"> |
| |
| <blockquote> |
| <div></div></blockquote> |
| <div class="section" id="metrics"> |
| <h1>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h1> |
| <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="section" id="setup"> |
| <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> |
| <p>First you must install statsd requirement:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install <span class="s1">'apache-airflow[statsd]'</span> |
| </pre></div> |
| </div> |
| <p>Add the following lines to your configuration file e.g. <code class="docutils literal notranslate"><span class="pre">airflow.cfg</span></code></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 class="docutils align-default"> |
| <colgroup> |
| <col style="width: 35%" /> |
| <col style="width: 65%" /> |
| </colgroup> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Name</p></th> |
| <th class="head"><p>Description</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p><job_name>_start</p></td> |
| <td><p>Number of started <job_name> job, ex. SchedulerJob, LocalTaskJob</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><job_name>_end</p></td> |
| <td><p>Number of ended <job_name> job, ex. SchedulerJob, LocalTaskJob</p></td> |
| </tr> |
| <tr class="row-even"><td><p>operator_failures_<operator_name></p></td> |
| <td><p>Operator <operator_name> failures</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>operator_successes_<operator_name></p></td> |
| <td><p>Operator <operator_name> successes</p></td> |
| </tr> |
| <tr class="row-even"><td><p>ti_failures</p></td> |
| <td><p>Overall task instances failures</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>ti_successes</p></td> |
| <td><p>Overall task instances successes</p></td> |
| </tr> |
| <tr class="row-even"><td><p>zombies_killed</p></td> |
| <td><p>Zombie tasks killed</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>scheduler_heartbeat</p></td> |
| <td><p>Scheduler heartbeats</p></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 class="docutils align-default"> |
| <colgroup> |
| <col style="width: 39%" /> |
| <col style="width: 61%" /> |
| </colgroup> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Name</p></th> |
| <th class="head"><p>Description</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p>collect_dags</p></td> |
| <td><p>Seconds taken to scan and import DAGs</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>dagbag_import_errors</p></td> |
| <td><p>DAG import errors</p></td> |
| </tr> |
| <tr class="row-even"><td><p>dagbag_size</p></td> |
| <td><p>DAG bag size</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>dag_processing.last_runtime.<dag_file></p></td> |
| <td><p>Seconds spent processing <dag_file> (in most recent iteration)</p></td> |
| </tr> |
| <tr class="row-even"><td><p>dag_processing.last_run.seconds_ago.<dag_file></p></td> |
| <td><p>Seconds since <dag_file> was last processed</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>executor.open_slots</p></td> |
| <td><p>Number of open slots on executor</p></td> |
| </tr> |
| <tr class="row-even"><td><p>executor.queued_tasks</p></td> |
| <td><p>Number of queued tasks on executor</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>executor.running_tasks</p></td> |
| <td><p>Number of running tasks on executor</p></td> |
| </tr> |
| <tr class="row-even"><td><p>pool.open_slots.<pool_name></p></td> |
| <td><p>Number of open slots in the pool</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>pool.used_slots.<pool_name></p></td> |
| <td><p>Number of used slots in the pool</p></td> |
| </tr> |
| <tr class="row-even"><td><p>pool.starving_tasks.<pool_name></p></td> |
| <td><p>Number of starving tasks in the pool</p></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 class="docutils align-default"> |
| <colgroup> |
| <col style="width: 40%" /> |
| <col style="width: 60%" /> |
| </colgroup> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Name</p></th> |
| <th class="head"><p>Description</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p>dagrun.dependency-check.<dag_id></p></td> |
| <td><p>Seconds taken to check DAG dependencies</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>dag.<dag_id>.<task_id>.duration</p></td> |
| <td><p>Seconds taken to finish a task</p></td> |
| </tr> |
| <tr class="row-even"><td><p>dag.loading-duration.<dag_id></p></td> |
| <td><p>Seconds taken to load the given DAG</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>dagrun.duration.success.<dag_id></p></td> |
| <td><p>Seconds taken for a DagRun to reach success state</p></td> |
| </tr> |
| <tr class="row-even"><td><p>dagrun.duration.failed.<dag_id></p></td> |
| <td><p>Seconds taken for a DagRun to reach failed state</p></td> |
| </tr> |
| <tr class="row-odd"><td><p>dagrun.schedule_delay.<dag_id></p></td> |
| <td><p>Seconds of delay between the scheduled DagRun |
| start date and the actual DagRun start date</p></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 float-left" 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>. |
| <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. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |