Google Git
Sign in
apache / beam-site / refs/heads/release-docs / . / pydoc / 2.67.0 / _modules / apache_beam / metrics / metric.html
blob: 98db64f8267ea1a6c854da4ac91ae617fe6ed932 [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.metric &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.metric</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.metric</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">User-facing classes for Metrics API.</span>
<span class="sd">The classes in this file allow users to define and use metrics to be collected</span>
<span class="sd">and displayed as part of their pipeline execution.</span>
<span class="sd">- Metrics - This class lets pipeline and transform writers create and access</span>
<span class="sd"> metric objects such as counters, distributions, etc.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="c1"># mypy: disallow-untyped-defs</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">re</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">TYPE_CHECKING</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">FrozenSet</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">Iterable</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">Iterator</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">List</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="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Set</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">Type</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">Union</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics</span><span class="w"> </span><span class="kn">import</span> <span class="n">cells</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.execution</span><span class="w"> </span><span class="kn">import</span> <span class="n">MetricResult</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.execution</span><span class="w"> </span><span class="kn">import</span> <span class="n">MetricUpdater</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BoundedTrie</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">Counter</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">Distribution</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">Gauge</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">MetricName</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">StringSet</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.execution</span><span class="w"> </span><span class="kn">import</span> <span class="n">MetricKey</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">apache_beam.metrics.metricbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">Metric</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Metrics&#39;</span><span class="p">,</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">,</span> <span class="s1">&#39;Lineage&#39;</span><span class="p">]</span>
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="Metrics">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Metrics</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Lets users create/access metric objects during pipeline execution.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Metrics.get_namespace">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.get_namespace">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="nb">type</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">.</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="n">namespace</span><span class="o">.</span><span class="vm">__module__</span><span class="p">,</span> <span class="n">namespace</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">namespace</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unknown namespace type&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Metrics.counter">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.counter">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">counter</span><span class="p">(</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</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="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Metrics.DelegatingCounter&#39;</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains or creates a Counter metric.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Counter object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingCounter</span><span class="p">(</span><span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span></div>
<div class="viewcode-block" id="Metrics.distribution">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.distribution">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">distribution</span><span class="p">(</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</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="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Metrics.DelegatingDistribution&#39;</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains or creates a Distribution metric.</span>
<span class="sd"> Distribution metrics are restricted to integer-only distributions.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Distribution object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingDistribution</span><span class="p">(</span><span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span></div>
<div class="viewcode-block" id="Metrics.gauge">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.gauge">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">gauge</span><span class="p">(</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</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="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Metrics.DelegatingGauge&#39;</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains or creates a Gauge metric.</span>
<span class="sd"> Gauge metrics are restricted to integer-only values.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Distribution object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingGauge</span><span class="p">(</span><span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span></div>
<div class="viewcode-block" id="Metrics.string_set">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.string_set">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">string_set</span><span class="p">(</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</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="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Metrics.DelegatingStringSet&#39;</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains or creates a String set metric.</span>
<span class="sd"> String set metrics are restricted to string values.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A StringSet object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingStringSet</span><span class="p">(</span><span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span></div>
<div class="viewcode-block" id="Metrics.bounded_trie">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.bounded_trie">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">bounded_trie</span><span class="p">(</span>
<span class="n">namespace</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Type</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="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Metrics.DelegatingBoundedTrie&#39;</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains or creates a Bounded Trie metric.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A BoundedTrie object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingBoundedTrie</span><span class="p">(</span><span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span></div>
<div class="viewcode-block" id="Metrics.DelegatingCounter">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.DelegatingCounter">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">DelegatingCounter</span><span class="p">(</span><span class="n">Counter</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Metrics Counter that Delegates functionality to MetricsEnvironment.&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="n">process_wide</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inc</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span> <span class="c1"># type: ignore[method-assign]</span>
<span class="n">cells</span><span class="o">.</span><span class="n">CounterCell</span><span class="p">,</span>
<span class="n">metric_name</span><span class="p">,</span>
<span class="n">default_value</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">process_wide</span><span class="o">=</span><span class="n">process_wide</span><span class="p">)</span></div>
<div class="viewcode-block" id="Metrics.DelegatingDistribution">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.DelegatingDistribution">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">DelegatingDistribution</span><span class="p">(</span><span class="n">Distribution</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Metrics Distribution Delegates functionality to MetricsEnvironment.&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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span><span class="n">cells</span><span class="o">.</span><span class="n">DistributionCell</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">)</span> <span class="c1"># type: ignore[method-assign]</span></div>
<div class="viewcode-block" id="Metrics.DelegatingGauge">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.DelegatingGauge">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">DelegatingGauge</span><span class="p">(</span><span class="n">Gauge</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Metrics Gauge that Delegates functionality to MetricsEnvironment.&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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span><span class="n">cells</span><span class="o">.</span><span class="n">GaugeCell</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">)</span> <span class="c1"># type: ignore[method-assign]</span></div>
<div class="viewcode-block" id="Metrics.DelegatingStringSet">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.DelegatingStringSet">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">DelegatingStringSet</span><span class="p">(</span><span class="n">StringSet</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Metrics StringSet that Delegates functionality to MetricsEnvironment.&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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span><span class="n">cells</span><span class="o">.</span><span class="n">StringSetCell</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">)</span> <span class="c1"># type: ignore[method-assign]</span></div>
<div class="viewcode-block" id="Metrics.DelegatingBoundedTrie">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Metrics.DelegatingBoundedTrie">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">DelegatingBoundedTrie</span><span class="p">(</span><span class="n">BoundedTrie</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Metrics StringSet that Delegates functionality to MetricsEnvironment.&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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span><span class="n">cells</span><span class="o">.</span><span class="n">BoundedTrieCell</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">)</span> <span class="c1"># type: ignore[method-assign]</span></div>
</div>
<span class="k">class</span><span class="w"> </span><span class="nc">MetricResults</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">COUNTERS</span> <span class="o">=</span> <span class="s2">&quot;counters&quot;</span>
<span class="n">DISTRIBUTIONS</span> <span class="o">=</span> <span class="s2">&quot;distributions&quot;</span>
<span class="n">GAUGES</span> <span class="o">=</span> <span class="s2">&quot;gauges&quot;</span>
<span class="n">STRINGSETS</span> <span class="o">=</span> <span class="s2">&quot;string_sets&quot;</span>
<span class="n">BOUNDED_TRIES</span> <span class="o">=</span> <span class="s2">&quot;bounded_tries&quot;</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_matches_name</span><span class="p">(</span><span class="nb">filter</span><span class="p">:</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">,</span> <span class="n">metric_key</span><span class="p">:</span> <span class="s1">&#39;MetricKey&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="k">if</span> <span class="p">((</span><span class="nb">filter</span><span class="o">.</span><span class="n">namespaces</span> <span class="ow">and</span>
<span class="n">metric_key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span> <span class="ow">not</span> <span class="ow">in</span> <span class="nb">filter</span><span class="o">.</span><span class="n">namespaces</span><span class="p">)</span> <span class="ow">or</span>
<span class="p">(</span><span class="nb">filter</span><span class="o">.</span><span class="n">names</span> <span class="ow">and</span> <span class="n">metric_key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="nb">filter</span><span class="o">.</span><span class="n">names</span><span class="p">)):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_is_sub_list</span><span class="p">(</span><span class="n">needle</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">haystack</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;True iff `needle` is a sub-list of `haystack` (i.e. a contiguous slice</span>
<span class="sd"> of `haystack` exactly matches `needle`&quot;&quot;&quot;</span>
<span class="n">needle_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">needle</span><span class="p">)</span>
<span class="n">haystack_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">haystack</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">haystack_len</span> <span class="o">-</span> <span class="n">needle_len</span> <span class="o">+</span> <span class="mi">1</span><span class="p">):</span>
<span class="k">if</span> <span class="n">haystack</span><span class="p">[</span><span class="n">i</span><span class="p">:</span><span class="n">i</span> <span class="o">+</span> <span class="n">needle_len</span><span class="p">]</span> <span class="o">==</span> <span class="n">needle</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_matches_sub_path</span><span class="p">(</span><span class="n">actual_scope</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">filter_scope</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;True iff the &#39;/&#39;-delimited pieces of filter_scope exist as a sub-list</span>
<span class="sd"> of the &#39;/&#39;-delimited pieces of actual_scope&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span>
<span class="n">actual_scope</span> <span class="ow">and</span> <span class="n">MetricResults</span><span class="o">.</span><span class="n">_is_sub_list</span><span class="p">(</span>
<span class="n">filter_scope</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">),</span> <span class="n">actual_scope</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)))</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_matches_scope</span><span class="p">(</span><span class="nb">filter</span><span class="p">:</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">,</span> <span class="n">metric_key</span><span class="p">:</span> <span class="s1">&#39;MetricKey&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">filter</span><span class="o">.</span><span class="n">steps</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">step</span> <span class="ow">in</span> <span class="nb">filter</span><span class="o">.</span><span class="n">steps</span><span class="p">:</span>
<span class="k">if</span> <span class="n">MetricResults</span><span class="o">.</span><span class="n">_matches_sub_path</span><span class="p">(</span><span class="n">metric_key</span><span class="o">.</span><span class="n">step</span><span class="p">,</span> <span class="n">step</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">matches</span><span class="p">(</span>
<span class="nb">filter</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;MetricsFilter&#39;</span><span class="p">],</span> <span class="n">metric_key</span><span class="p">:</span> <span class="s1">&#39;MetricKey&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">filter</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">if</span> <span class="p">(</span><span class="n">MetricResults</span><span class="o">.</span><span class="n">_matches_name</span><span class="p">(</span><span class="nb">filter</span><span class="p">,</span> <span class="n">metric_key</span><span class="p">)</span> <span class="ow">and</span>
<span class="n">MetricResults</span><span class="o">.</span><span class="n">_matches_scope</span><span class="p">(</span><span class="nb">filter</span><span class="p">,</span> <span class="n">metric_key</span><span class="p">)):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">def</span><span class="w"> </span><span class="nf">query</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">filter</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;MetricsFilter&#39;</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="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="s1">&#39;MetricResult&#39;</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Queries the runner for existing user metrics that match the filter.</span>
<span class="sd"> It should return a dictionary, with lists of each kind of metric, and</span>
<span class="sd"> each list contains the corresponding kind of MetricResult. Like so:</span>
<span class="sd"> {</span>
<span class="sd"> &quot;counters&quot;: [MetricResult(counter_key, committed, attempted), ...],</span>
<span class="sd"> &quot;distributions&quot;: [MetricResult(dist_key, committed, attempted), ...],</span>
<span class="sd"> &quot;gauges&quot;: [], // Empty list if nothing matched the filter.</span>
<span class="sd"> &quot;string_sets&quot;: [] [MetricResult(string_set_key, committed, attempted),</span>
<span class="sd"> ...]</span>
<span class="sd"> }</span>
<span class="sd"> The committed / attempted values are DistributionResult / GaugeResult / int</span>
<span class="sd"> / set objects.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<div class="viewcode-block" id="MetricsFilter">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">MetricsFilter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Simple object to filter metrics results.</span>
<span class="sd"> If filters by matching a result&#39;s step-namespace-name with three internal</span>
<span class="sd"> sets. No execution/matching logic is added to this object, so that it may</span>
<span class="sd"> be used to construct arguments as an RPC request. It is left for runners</span>
<span class="sd"> to implement matching logic by themselves.</span>
<span class="sd"> Note: This class only supports user defined metrics.</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="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_names</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_namespaces</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_steps</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">steps</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">return</span> <span class="nb">frozenset</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_steps</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">return</span> <span class="nb">frozenset</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_names</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">namespaces</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">return</span> <span class="nb">frozenset</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_namespaces</span><span class="p">)</span>
<div class="viewcode-block" id="MetricsFilter.with_metric">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_metric">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_metric</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric</span><span class="p">:</span> <span class="s1">&#39;Metric&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">metric</span><span class="o">.</span><span class="n">metric_name</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="n">metric</span><span class="o">.</span><span class="n">metric_name</span><span class="o">.</span><span class="n">namespace</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">with_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span></div>
<div class="viewcode-block" id="MetricsFilter.with_name">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_name">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">with_names</span><span class="p">([</span><span class="n">name</span><span class="p">])</span></div>
<div class="viewcode-block" id="MetricsFilter.with_names">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_names">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_names</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">names</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Names must be a collection, not a string&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_names</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">names</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="MetricsFilter.with_namespace">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_namespace">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_namespace</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">Union</span><span class="p">[</span><span class="n">Type</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">with_namespaces</span><span class="p">([</span><span class="n">namespace</span><span class="p">])</span></div>
<div class="viewcode-block" id="MetricsFilter.with_namespaces">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_namespaces">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_namespaces</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">namespaces</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Type</span><span class="p">,</span> <span class="nb">str</span><span class="p">]])</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">namespaces</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Namespaces must be an iterable, not a string&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_namespaces</span><span class="o">.</span><span class="n">update</span><span class="p">([</span><span class="n">Metrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">ns</span><span class="p">)</span> <span class="k">for</span> <span class="n">ns</span> <span class="ow">in</span> <span class="n">namespaces</span><span class="p">])</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="MetricsFilter.with_step">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_step">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">step</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">with_steps</span><span class="p">([</span><span class="n">step</span><span class="p">])</span></div>
<div class="viewcode-block" id="MetricsFilter.with_steps">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.MetricsFilter.with_steps">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">with_steps</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">steps</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="s1">&#39;MetricsFilter&#39;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">steps</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Steps must be an iterable, not a string&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_steps</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">steps</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
</div>
<div class="viewcode-block" id="Lineage">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Lineage</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Standard collection of metrics used to record source and sinks information</span>
<span class="sd"> for lineage tracking.&quot;&quot;&quot;</span>
<span class="n">LINEAGE_NAMESPACE</span> <span class="o">=</span> <span class="s2">&quot;lineage&quot;</span>
<span class="n">SOURCE</span> <span class="o">=</span> <span class="s2">&quot;sources_v2&quot;</span>
<span class="n">SINK</span> <span class="o">=</span> <span class="s2">&quot;sinks_v2&quot;</span>
<span class="n">_METRICS</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">SOURCE</span><span class="p">:</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">bounded_trie</span><span class="p">(</span><span class="n">LINEAGE_NAMESPACE</span><span class="p">,</span> <span class="n">SOURCE</span><span class="p">),</span>
<span class="n">SINK</span><span class="p">:</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">bounded_trie</span><span class="p">(</span><span class="n">LINEAGE_NAMESPACE</span><span class="p">,</span> <span class="n">SINK</span><span class="p">)</span>
<span class="p">}</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">label</span><span class="p">:</span> <span class="nb">str</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;Create a Lineage with valid label (:data:`~Lineage.SOURCE` or</span>
<span class="sd"> :data:`~Lineage.SINK`)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metric</span> <span class="o">=</span> <span class="n">Lineage</span><span class="o">.</span><span class="n">_METRICS</span><span class="p">[</span><span class="n">label</span><span class="p">]</span>
<div class="viewcode-block" id="Lineage.sources">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.sources">[docs]</a>
<span class="nd">@classmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sources</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Lineage&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">Lineage</span><span class="o">.</span><span class="n">SOURCE</span><span class="p">)</span></div>
<div class="viewcode-block" id="Lineage.sinks">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.sinks">[docs]</a>
<span class="nd">@classmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sinks</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;Lineage&#39;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">Lineage</span><span class="o">.</span><span class="n">SINK</span><span class="p">)</span></div>
<span class="n">_RESERVED_CHARS</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;[:\s.]&#39;</span><span class="p">)</span>
<div class="viewcode-block" id="Lineage.wrap_segment">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.wrap_segment">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">wrap_segment</span><span class="p">(</span><span class="n">segment</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Wrap segment to valid segment name.</span>
<span class="sd"> Specifically, If there are reserved chars (colon, whitespace, dot), escape</span>
<span class="sd"> with backtick. If the segment is already wrapped, return the original.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">segment</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;`&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">segment</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">&quot;`&quot;</span><span class="p">):</span> <span class="k">return</span> <span class="n">segment</span>
<span class="k">if</span> <span class="n">Lineage</span><span class="o">.</span><span class="n">_RESERVED_CHARS</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">segment</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">&quot;`&quot;</span> <span class="o">+</span> <span class="n">segment</span> <span class="o">+</span> <span class="s2">&quot;`&quot;</span>
<span class="k">return</span> <span class="n">segment</span></div>
<div class="viewcode-block" id="Lineage.get_fq_name">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.get_fq_name">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_fq_name</span><span class="p">(</span>
<span class="n">system</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">*</span><span class="n">segments</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">subtype</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="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Assemble fully qualified name</span>
<span class="sd"> (`FQN &lt;https://cloud.google.com/data-catalog/docs/fully-qualified-names&gt;`_).</span>
<span class="sd"> Format:</span>
<span class="sd"> - `system:segment1.segment2`</span>
<span class="sd"> - `system:subtype:segment1.segment2`</span>
<span class="sd"> - `system:`segment1.with.dots:colons`.segment2`</span>
<span class="sd"> This helper method is for internal and testing usage only.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">segs</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="nb">map</span><span class="p">(</span><span class="n">Lineage</span><span class="o">.</span><span class="n">wrap_segment</span><span class="p">,</span> <span class="n">segments</span><span class="p">))</span>
<span class="k">if</span> <span class="n">subtype</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;:&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">((</span><span class="n">system</span><span class="p">,</span> <span class="n">subtype</span><span class="p">,</span> <span class="n">segs</span><span class="p">))</span>
<span class="k">return</span> <span class="s1">&#39;:&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">((</span><span class="n">system</span><span class="p">,</span> <span class="n">segs</span><span class="p">))</span></div>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_fqn_parts</span><span class="p">(</span>
<span class="n">system</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="n">segments</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">subtype</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">last_segment_sep</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="o">-&gt;</span> <span class="n">Iterator</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">yield</span> <span class="n">system</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span>
<span class="k">if</span> <span class="n">subtype</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">subtype</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span>
<span class="k">if</span> <span class="n">segments</span><span class="p">:</span>
<span class="k">for</span> <span class="n">segment</span> <span class="ow">in</span> <span class="n">segments</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">yield</span> <span class="n">segment</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span>
<span class="k">if</span> <span class="n">last_segment_sep</span><span class="p">:</span>
<span class="n">sub_segments</span> <span class="o">=</span> <span class="n">segments</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">last_segment_sep</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sub_segment</span> <span class="ow">in</span> <span class="n">sub_segments</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">yield</span> <span class="n">sub_segment</span> <span class="o">+</span> <span class="n">last_segment_sep</span>
<span class="k">yield</span> <span class="n">sub_segments</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">segments</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<div class="viewcode-block" id="Lineage.add">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.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">system</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="n">segments</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">subtype</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">last_segment_sep</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="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Adds the given details as Lineage.</span>
<span class="sd"> For asset level lineage the resource location should be specified as</span>
<span class="sd"> Dataplex FQN, see</span>
<span class="sd"> https://cloud.google.com/data-catalog/docs/fully-qualified-names</span>
<span class="sd"> Example of adding FQN components:</span>
<span class="sd"> - `add(&quot;system&quot;, &quot;segment1&quot;, &quot;segment2&quot;)`</span>
<span class="sd"> - `add(&quot;system&quot;, &quot;segment1&quot;, &quot;segment2&quot;, subtype=&quot;subtype&quot;)`</span>
<span class="sd"> Example of adding a FQN:</span>
<span class="sd"> - `add(&quot;system:segment1.segment2&quot;)`</span>
<span class="sd"> - `add(&quot;system:subtype:segment1.segment2&quot;)`</span>
<span class="sd"> The first positional argument serves as system, if full segments are</span>
<span class="sd"> provided, or the full FQN if it is provided as a single argument.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_raw</span><span class="p">(</span>
<span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_fqn_parts</span><span class="p">(</span>
<span class="n">system</span><span class="p">,</span>
<span class="o">*</span><span class="n">segments</span><span class="p">,</span>
<span class="n">subtype</span><span class="o">=</span><span class="n">subtype</span><span class="p">,</span>
<span class="n">last_segment_sep</span><span class="o">=</span><span class="n">last_segment_sep</span><span class="p">))</span></div>
<div class="viewcode-block" id="Lineage.add_raw">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.add_raw">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">add_raw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">rollup_segments</span><span class="p">:</span> <span class="nb">str</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;Adds the given fqn as lineage.</span>
<span class="sd"> `rollup_segments` should be an iterable of strings whose concatenation</span>
<span class="sd"> is a valid Dataplex FQN. In particular, this means they will often have</span>
<span class="sd"> trailing delimiters.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rollup_segments</span><span class="p">)</span></div>
<div class="viewcode-block" id="Lineage.query">
<a class="viewcode-back" href="../../../apache_beam.metrics.metric.html#apache_beam.metrics.metric.Lineage.query">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">query</span><span class="p">(</span><span class="n">results</span><span class="p">:</span> <span class="n">MetricResults</span><span class="p">,</span>
<span class="n">label</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">truncated_marker</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;*&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">label</span> <span class="ow">in</span> <span class="n">Lineage</span><span class="o">.</span><span class="n">_METRICS</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Label </span><span class="si">{}</span><span class="s2"> does not exist for Lineage&quot;</span><span class="p">,</span> <span class="n">label</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">results</span><span class="o">.</span><span class="n">query</span><span class="p">(</span>
<span class="n">MetricsFilter</span><span class="p">()</span><span class="o">.</span><span class="n">with_namespace</span><span class="p">(</span><span class="n">Lineage</span><span class="o">.</span><span class="n">LINEAGE_NAMESPACE</span><span class="p">)</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span>
<span class="n">label</span><span class="p">))[</span><span class="n">MetricResults</span><span class="o">.</span><span class="n">BOUNDED_TRIES</span><span class="p">]</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">metric</span> <span class="ow">in</span> <span class="n">response</span><span class="p">:</span>
<span class="k">for</span> <span class="n">fqn</span> <span class="ow">in</span> <span class="n">metric</span><span class="o">.</span><span class="n">committed</span><span class="o">.</span><span class="n">flattened</span><span class="p">():</span>
<span class="n">result</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fqn</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="p">(</span><span class="n">truncated_marker</span> <span class="k">if</span> <span class="n">fqn</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">else</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
<span class="k">for</span> <span class="n">fqn</span> <span class="ow">in</span> <span class="n">metric</span><span class="o">.</span><span class="n">attempted</span><span class="o">.</span><span class="n">flattened</span><span class="p">():</span>
<span class="n">result</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fqn</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="p">(</span><span class="n">truncated_marker</span> <span class="k">if</span> <span class="n">fqn</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">else</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
<span class="k">return</span> <span class="n">result</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>