Google Git
Sign in
apache / beam-site / refs/heads/release-docs / . / pydoc / 2.67.0 / _modules / apache_beam / metrics / metricbase.html
blob: a486e1e65d7d6a90ad5e33be1e56a568909af338 [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>apache_beam.metrics.metricbase &mdash; Apache Beam 2.67.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=959b4fbe"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.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" aria-label="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="Navigation menu">
<ul>
<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"><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.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>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.yaml.html">apache_beam.yaml 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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">apache_beam.metrics.metricbase</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.metrics.metricbase</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">The classes in this file are interfaces for metrics. They are not intended</span>
<span class="sd">to be subclassed or created directly by users. To work with and access metrics,</span>
<span class="sd">users should use the classes and methods exposed in metric.py.</span>
<span class="sd">Available classes:</span>
<span class="sd">- Metric - Base interface of a metrics object.</span>
<span class="sd">- Counter - Counter metric interface. Allows a count to be incremented or</span>
<span class="sd"> decremented during pipeline execution.</span>
<span class="sd">- Distribution - Distribution Metric interface. Allows statistics about the</span>
<span class="sd"> distribution of a variable to be collected during pipeline execution.</span>
<span class="sd">- Gauge - Gauge Metric interface. Allows to track the latest value of a</span>
<span class="sd"> variable during pipeline execution.</span>
<span class="sd">- MetricName - Namespace and name used to refer to a Metric.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Optional</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;Metric&#39;</span><span class="p">,</span>
<span class="s1">&#39;Counter&#39;</span><span class="p">,</span>
<span class="s1">&#39;Distribution&#39;</span><span class="p">,</span>
<span class="s1">&#39;Gauge&#39;</span><span class="p">,</span>
<span class="s1">&#39;StringSet&#39;</span><span class="p">,</span>
<span class="s1">&#39;BoundedTrie&#39;</span><span class="p">,</span>
<span class="s1">&#39;Histogram&#39;</span><span class="p">,</span>
<span class="s1">&#39;MetricName&#39;</span>
<span class="p">]</span>
<div class="viewcode-block" id="MetricName">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.MetricName">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">MetricName</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The name of a metric.</span>
<span class="sd"> The name of a metric consists of a namespace and a name. The namespace</span>
<span class="sd"> allows grouping related metrics together and also prevents collisions</span>
<span class="sd"> between multiple metrics of the same name.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
<span class="n">name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
<span class="n">urn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">labels</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Initializes ``MetricName``.</span>
<span class="sd"> Note: namespace and name should be set for user metrics,</span>
<span class="sd"> urn and labels should be set for an arbitrary metric to package into a</span>
<span class="sd"> MonitoringInfo.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A string with the namespace of a metric.</span>
<span class="sd"> name: A string with the name of a metric.</span>
<span class="sd"> urn: URN to populate on a MonitoringInfo, when sending to RunnerHarness.</span>
<span class="sd"> labels: Labels to populate on a MonitoringInfo</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">urn</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">namespace</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Metric namespace must be non-empty&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">name</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Metric name must be non-empty&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="n">namespace</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">urn</span> <span class="o">=</span> <span class="n">urn</span>
<span class="bp">self</span><span class="o">.</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span> <span class="k">if</span> <span class="n">labels</span> <span class="k">else</span> <span class="p">{}</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">namespace</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">urn</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">urn</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">labels</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">labels</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">urn</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;MetricName(namespace=</span><span class="si">{}</span><span class="s1">, name=</span><span class="si">{}</span><span class="s1">, urn=</span><span class="si">{}</span><span class="s1">, labels=</span><span class="si">{}</span><span class="s1">)&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">urn</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="c1"># User counter case.</span>
<span class="k">return</span> <span class="s1">&#39;MetricName(namespace=</span><span class="si">{}</span><span class="s1">, name=</span><span class="si">{}</span><span class="s1">)&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">urn</span><span class="p">)</span> <span class="o">+</span>
<span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="o">.</span><span class="n">items</span><span class="p">()))</span>
<div class="viewcode-block" id="MetricName.fast_name">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.MetricName.fast_name">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">fast_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
<span class="n">urn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">urn</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
<span class="n">labels</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="p">:</span>
<span class="n">labels</span> <span class="o">=</span> <span class="s1">&#39;_&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">=</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="o">.</span><span class="n">items</span><span class="p">()])</span>
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">%d</span><span class="s1">_</span><span class="si">%s%s%s%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="n">name</span><span class="p">,</span> <span class="n">namespace</span><span class="p">,</span> <span class="n">urn</span><span class="p">,</span> <span class="n">labels</span><span class="p">)</span></div>
</div>
<div class="viewcode-block" id="Metric">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Metric">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Metric</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Base interface of a metric object.&quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">:</span> <span class="n">MetricName</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metric_name</span> <span class="o">=</span> <span class="n">metric_name</span></div>
<div class="viewcode-block" id="Counter">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Counter">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Counter</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Counter metric interface. Allows a count to be incremented/decremented</span>
<span class="sd"> during pipeline execution.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Counter.inc">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Counter.inc">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">inc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
<div class="viewcode-block" id="Counter.dec">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Counter.dec">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">dec</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inc</span><span class="p">(</span><span class="o">-</span><span class="n">n</span><span class="p">)</span></div>
</div>
<div class="viewcode-block" id="Distribution">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Distribution">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Distribution</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Distribution Metric interface.</span>
<span class="sd"> Allows statistics about the distribution of a variable to be collected during</span>
<span class="sd"> pipeline execution.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Distribution.update">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Distribution.update">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
</div>
<div class="viewcode-block" id="Gauge">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Gauge">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Gauge</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gauge Metric interface.</span>
<span class="sd"> Allows tracking of the latest value of a variable during pipeline</span>
<span class="sd"> execution.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Gauge.set">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Gauge.set">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
</div>
<div class="viewcode-block" id="StringSet">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.StringSet">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StringSet</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;StringSet Metric interface.</span>
<span class="sd"> Reports set of unique string values during pipeline execution..&quot;&quot;&quot;</span>
<div class="viewcode-block" id="StringSet.add">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.StringSet.add">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
</div>
<div class="viewcode-block" id="BoundedTrie">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.BoundedTrie">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">BoundedTrie</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;BoundedTrie Metric interface.</span>
<span class="sd"> Reports set of unique string values during pipeline execution..&quot;&quot;&quot;</span>
<div class="viewcode-block" id="BoundedTrie.add">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.BoundedTrie.add">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
</div>
<div class="viewcode-block" id="Histogram">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Histogram">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Histogram</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Histogram Metric interface.</span>
<span class="sd"> Allows statistics about the percentile of a variable to be collected during</span>
<span class="sd"> pipeline execution.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Histogram.update">
<a class="viewcode-back" href="../../../apache_beam.metrics.metricbase.html#apache_beam.metrics.metricbase.Histogram.update">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
</div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright %Y, Apache Beam.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>