| |
| |
| <!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.internal.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 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.internal.metrics.metric module" href="apache_beam.internal.metrics.metric.html" /> |
| <link rel="prev" title="apache_beam.internal.metrics package" href="apache_beam.internal.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 current"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.internal.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.internal.gcp.html">apache_beam.internal.gcp package</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.internal.metrics.html">apache_beam.internal.metrics package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.internal.metrics.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.internal.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></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.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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.internal.html">apache_beam.internal package</a> »</li> |
| |
| <li><a href="apache_beam.internal.metrics.html">apache_beam.internal.metrics package</a> »</li> |
| |
| <li>apache_beam.internal.metrics.cells module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.internal.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.internal.metrics.cells"> |
| <span id="apache-beam-internal-metrics-cells-module"></span><h1>apache_beam.internal.metrics.cells module<a class="headerlink" href="#module-apache_beam.internal.metrics.cells" title="Permalink to this headline">¶</a></h1> |
| <p>This file contains internal 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> |
| <p>For internal use only. No backwards compatibility guarantees.</p> |
| <dl class="class"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell"> |
| <em class="property">class </em><code class="descclassname">apache_beam.internal.metrics.cells.</code><code class="descname">HistogramCell</code><span class="sig-paren">(</span><em>bucket_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramCell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.metrics.cells.html#apache_beam.metrics.cells.MetricCell" title="apache_beam.metrics.cells.MetricCell"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.metrics.cells.MetricCell</span></code></a></p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <p>Tracks the current value and delta for a histogram metric.</p> |
| <p>Each cell tracks the state of a metric independently per context per bundle. |
| Therefore, each metric has a different cell in each bundle, that is later |
| aggregated.</p> |
| <p>This class is thread safe since underlying histogram object is thread safe.</p> |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell.reset"> |
| <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramCell.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell.reset" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell.combine"> |
| <code class="descname">combine</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramCell.combine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell.combine" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell.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/internal/metrics/cells.html#HistogramCell.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell.update" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell.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/internal/metrics/cells.html#HistogramCell.get_cumulative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell.get_cumulative" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCell.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/internal/metrics/cells.html#HistogramCell.to_runner_api_monitoring_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCell.to_runner_api_monitoring_info" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramCellFactory"> |
| <em class="property">class </em><code class="descclassname">apache_beam.internal.metrics.cells.</code><code class="descname">HistogramCellFactory</code><span class="sig-paren">(</span><em>bucket_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramCellFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramCellFactory" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.metrics.cells.html#apache_beam.metrics.cells.MetricCellFactory" title="apache_beam.metrics.cells.MetricCellFactory"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.metrics.cells.MetricCellFactory</span></code></a></p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramResult"> |
| <em class="property">class </em><code class="descclassname">apache_beam.internal.metrics.cells.</code><code class="descname">HistogramResult</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramResult" 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.internal.metrics.cells.HistogramResult.p99"> |
| <code class="descname">p99</code><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramResult.p99" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramResult.p95"> |
| <code class="descname">p95</code><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramResult.p95" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramResult.p90"> |
| <code class="descname">p90</code><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramResult.p90" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramData"> |
| <em class="property">class </em><code class="descclassname">apache_beam.internal.metrics.cells.</code><code class="descname">HistogramData</code><span class="sig-paren">(</span><em>histogram</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramData" 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>The data structure that holds data about a histogram metric.</p> |
| <p>This object is not thread safe, so it’s not supposed to be modified |
| outside the HistogramCell.</p> |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramData.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/internal/metrics/cells.html#HistogramData.get_cumulative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramData.get_cumulative" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramData.combine"> |
| <code class="descname">combine</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramData.combine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramData.combine" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramAggregator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.internal.metrics.cells.</code><code class="descname">HistogramAggregator</code><span class="sig-paren">(</span><em>bucket_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/internal/metrics/cells.html#HistogramAggregator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramAggregator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.metrics.cells.html#apache_beam.metrics.cells.MetricAggregator" title="apache_beam.metrics.cells.MetricAggregator"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.metrics.cells.MetricAggregator</span></code></a></p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <p>Aggregator for Histogram metric data during pipeline execution.</p> |
| <p>Values aggregated should be <code class="docutils literal notranslate"><span class="pre">HistogramData</span></code> objects.</p> |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramAggregator.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/internal/metrics/cells.html#HistogramAggregator.identity_element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramAggregator.identity_element" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramAggregator.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/internal/metrics/cells.html#HistogramAggregator.combine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramAggregator.combine" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.internal.metrics.cells.HistogramAggregator.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/internal/metrics/cells.html#HistogramAggregator.result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.internal.metrics.cells.HistogramAggregator.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.internal.metrics.metric.html" class="btn btn-neutral float-right" title="apache_beam.internal.metrics.metric module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.internal.metrics.html" class="btn btn-neutral float-left" title="apache_beam.internal.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> |
