| |
| |
| <!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>apache_beam.metrics.cells module — Apache Beam 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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="apache_beam.metrics.metric module" href="apache_beam.metrics.metric.html" /> |
| <link rel="prev" title="apache_beam.metrics package" href="apache_beam.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"> Apache Beam |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <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="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.metrics.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.metrics.cells module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.metrics.metric.html">apache_beam.metrics.metric module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.metrics.metricbase.html">apache_beam.metrics.metricbase module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.metrics.monitoring_infos.html">apache_beam.metrics.monitoring_infos module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</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">Apache Beam</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="apache_beam.metrics.html">apache_beam.metrics package</a> »</li> |
| |
| <li>apache_beam.metrics.cells module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.metrics.cells.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="module-apache_beam.metrics.cells"> |
| <span id="apache-beam-metrics-cells-module"></span><h1>apache_beam.metrics.cells module<a class="headerlink" href="#module-apache_beam.metrics.cells" title="Permalink to this headline">¶</a></h1> |
| <p>This file contains metric cell classes. A metric cell is used to accumulate |
| in-memory changes to a metric. It represents a specific metric in a single |
| context.</p> |
| <dl class="class"> |
| <dt id="apache_beam.metrics.cells.MetricCell"> |
| <em class="property">class </em><code class="descclassname">apache_beam.metrics.cells.</code><code class="descname">MetricCell</code><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <p>Accumulates in-memory changes to a metric.</p> |
| <p>A MetricCell represents a specific metric in a single context and bundle. |
| All subclasses must be thread safe, as these are used in the pipeline runners, |
| and may be subject to parallel/concurrent updates. Cells should only be used |
| directly within a runner.</p> |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricCell.update"> |
| <code class="descname">update</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell.update" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricCell.get_cumulative"> |
| <code class="descname">get_cumulative</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell.get_cumulative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell.get_cumulative" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricCell.to_runner_api_monitoring_info"> |
| <code class="descname">to_runner_api_monitoring_info</code><span class="sig-paren">(</span><em>name</em>, <em>transform_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell.to_runner_api_monitoring_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell.to_runner_api_monitoring_info" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricCell.to_runner_api_monitoring_info_impl"> |
| <code class="descname">to_runner_api_monitoring_info_impl</code><span class="sig-paren">(</span><em>name</em>, <em>transform_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell.to_runner_api_monitoring_info_impl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell.to_runner_api_monitoring_info_impl" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricCell.reset"> |
| <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCell.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCell.reset" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.metrics.cells.MetricCellFactory"> |
| <em class="property">class </em><code class="descclassname">apache_beam.metrics.cells.</code><code class="descname">MetricCellFactory</code><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricCellFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricCellFactory" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.metrics.cells.DistributionResult"> |
| <em class="property">class </em><code class="descclassname">apache_beam.metrics.cells.</code><code class="descname">DistributionResult</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#DistributionResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>The result of a Distribution metric.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.DistributionResult.max"> |
| <code class="descname">max</code><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult.max" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.DistributionResult.min"> |
| <code class="descname">min</code><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult.min" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.DistributionResult.count"> |
| <code class="descname">count</code><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult.count" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.DistributionResult.sum"> |
| <code class="descname">sum</code><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult.sum" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.DistributionResult.mean"> |
| <code class="descname">mean</code><a class="headerlink" href="#apache_beam.metrics.cells.DistributionResult.mean" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the float mean of the distribution.</p> |
| <p>If the distribution contains no elements, it returns None.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.metrics.cells.GaugeResult"> |
| <em class="property">class </em><code class="descclassname">apache_beam.metrics.cells.</code><code class="descname">GaugeResult</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#GaugeResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.GaugeResult" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.GaugeResult.value"> |
| <code class="descname">value</code><a class="headerlink" href="#apache_beam.metrics.cells.GaugeResult.value" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.metrics.cells.GaugeResult.timestamp"> |
| <code class="descname">timestamp</code><a class="headerlink" href="#apache_beam.metrics.cells.GaugeResult.timestamp" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.metrics.cells.MetricAggregator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.metrics.cells.</code><code class="descname">MetricAggregator</code><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricAggregator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricAggregator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <p>Base interface for aggregating metric data during pipeline execution.</p> |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricAggregator.identity_element"> |
| <code class="descname">identity_element</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricAggregator.identity_element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricAggregator.identity_element" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the identical element of an Aggregation.</p> |
| <dl class="docutils"> |
| <dt>For the identity element, it must hold that</dt> |
| <dd>Aggregator.combine(any_element, identity_element) == any_element.</dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricAggregator.combine"> |
| <code class="descname">combine</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricAggregator.combine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricAggregator.combine" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.metrics.cells.MetricAggregator.result"> |
| <code class="descname">result</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/metrics/cells.html#MetricAggregator.result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.metrics.cells.MetricAggregator.result" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.metrics.metric.html" class="btn btn-neutral float-right" title="apache_beam.metrics.metric module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.metrics.html" class="btn btn-neutral float-left" title="apache_beam.metrics package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright |
| |
| </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"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
