blob: 8a4a6d1bf8cc4d4f654e9d4b48dd25892411abd2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.testing.metric_result_matchers module &mdash; Apache Beam documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Apache Beam documentation" href="index.html"/>
<link rel="up" title="apache_beam.testing package" href="apache_beam.testing.html"/>
<link rel="next" title="apache_beam.testing.pipeline_verifiers module" href="apache_beam.testing.pipeline_verifiers.html"/>
<link rel="prev" title="apache_beam.testing.extra_assertions module" href="apache_beam.testing.extra_assertions.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal 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.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 current"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apache_beam.testing.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.datatype_inference.html">apache_beam.testing.datatype_inference module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.extra_assertions.html">apache_beam.testing.extra_assertions module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.testing.metric_result_matchers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.pipeline_verifiers.html">apache_beam.testing.pipeline_verifiers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.synthetic_pipeline.html">apache_beam.testing.synthetic_pipeline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_pipeline.html">apache_beam.testing.test_pipeline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_stream.html">apache_beam.testing.test_stream module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_utils.html">apache_beam.testing.test_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.util.html">apache_beam.testing.util module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.testing.html">apache_beam.testing package</a> &raquo;</li>
<li>apache_beam.testing.metric_result_matchers module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.testing.metric_result_matchers.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.testing.metric_result_matchers">
<span id="apache-beam-testing-metric-result-matchers-module"></span><h1>apache_beam.testing.metric_result_matchers module<a class="headerlink" href="#module-apache_beam.testing.metric_result_matchers" title="Permalink to this headline"></a></h1>
<p>MetricResult matchers for validating metrics in PipelineResults.</p>
<p>example usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">result</span> <span class="o">=</span> <span class="n">my_pipeline</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
<span class="n">all_metrics</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">metrics</span><span class="p">()</span><span class="o">.</span><span class="n">all_metrics</span><span class="p">()</span>
<span class="n">matchers</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">MetricResultMatcher</span><span class="p">(</span>
<span class="n">namespace</span><span class="o">=</span><span class="s1">&#39;myNamespace&#39;</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="s1">&#39;myName&#39;</span><span class="p">,</span>
<span class="n">step</span><span class="o">=</span><span class="s1">&#39;myStep&#39;</span><span class="p">,</span>
<span class="n">labels</span><span class="o">=</span><span class="p">{</span>
<span class="s1">&#39;pcollection&#39;</span><span class="p">:</span> <span class="s1">&#39;myCollection&#39;</span><span class="p">,</span>
<span class="s1">&#39;myCustomKey&#39;</span><span class="p">:</span> <span class="s1">&#39;myCustomValue&#39;</span>
<span class="p">},</span>
<span class="n">attempted</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span>
<span class="n">committed</span><span class="o">=</span><span class="mi">42</span>
<span class="p">)</span>
<span class="p">]</span>
<span class="n">errors</span> <span class="o">=</span> <span class="n">metric_result_matchers</span><span class="o">.</span><span class="n">verify_all</span><span class="p">(</span><span class="n">all_metrics</span><span class="p">,</span> <span class="n">matchers</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">errors</span><span class="p">,</span> <span class="n">errors</span><span class="p">)</span>
</pre></div>
</div>
<dl class="class">
<dt id="apache_beam.testing.metric_result_matchers.MetricResultMatcher">
<em class="property">class </em><code class="descclassname">apache_beam.testing.metric_result_matchers.</code><code class="descname">MetricResultMatcher</code><span class="sig-paren">(</span><em>namespace=None</em>, <em>name=None</em>, <em>step=None</em>, <em>labels=None</em>, <em>attempted=None</em>, <em>committed=None</em>, <em>sum_value=None</em>, <em>count_value=None</em>, <em>min_value=None</em>, <em>max_value=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#MetricResultMatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core/#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v1.9.0)"><code class="xref py py-class docutils literal"><span class="pre">hamcrest.core.base_matcher.BaseMatcher</span></code></a></p>
<p>A PyHamcrest matcher that validates counter MetricResults.</p>
<dl class="method">
<dt id="apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_to">
<code class="descname">describe_to</code><span class="sig-paren">(</span><em>description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#MetricResultMatcher.describe_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_to" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_mismatch">
<code class="descname">describe_mismatch</code><span class="sig-paren">(</span><em>metric_result</em>, <em>mismatch_description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#MetricResultMatcher.describe_mismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_mismatch" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.testing.metric_result_matchers.DistributionMatcher">
<em class="property">class </em><code class="descclassname">apache_beam.testing.metric_result_matchers.</code><code class="descname">DistributionMatcher</code><span class="sig-paren">(</span><em>sum_value=None</em>, <em>count_value=None</em>, <em>min_value=None</em>, <em>max_value=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#DistributionMatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core/#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v1.9.0)"><code class="xref py py-class docutils literal"><span class="pre">hamcrest.core.base_matcher.BaseMatcher</span></code></a></p>
<p>A PyHamcrest matcher that validates counter distributions.</p>
<dl class="method">
<dt id="apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_to">
<code class="descname">describe_to</code><span class="sig-paren">(</span><em>description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#DistributionMatcher.describe_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_to" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_mismatch">
<code class="descname">describe_mismatch</code><span class="sig-paren">(</span><em>distribution_result</em>, <em>mismatch_description</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#DistributionMatcher.describe_mismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_mismatch" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.testing.metric_result_matchers.verify_all">
<code class="descclassname">apache_beam.testing.metric_result_matchers.</code><code class="descname">verify_all</code><span class="sig-paren">(</span><em>all_metrics</em>, <em>matchers</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#verify_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.verify_all" title="Permalink to this definition"></a></dt>
<dd><p>Verified that every matcher matches a metric result in all_metrics.</p>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.testing.pipeline_verifiers.html" class="btn btn-neutral float-right" title="apache_beam.testing.pipeline_verifiers module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.testing.extra_assertions.html" class="btn btn-neutral" title="apache_beam.testing.extra_assertions module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>