pydoc/2.47.0/_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html - beam-site - Git at Google



 <!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.load_tests.load_test_metrics_utils &mdash; Apache Beam 2.47.0 documentation</title>


   <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
         <script type="text/javascript" src="../../../../_static/jquery.js"></script>
         <script type="text/javascript" src="../../../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../../../_static/doctools.js"></script>
         <script type="text/javascript" src="../../../../_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="../../../../_static/js/theme.js"></script>


   <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
 </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 class="version">
                 2.47.0
               </div>


 <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>
 <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="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="../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.testing.load_tests.load_test_metrics_utils</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.testing.load_tests.load_test_metrics_utils</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">Utility functions used for integrating Metrics API into load tests pipelines.</span>

 <span class="sd">Metrics are send to BigQuery in following format:</span>
 <span class="sd">test_id | submit_timestamp | metric_type | value</span>

 <span class="sd">The &#39;test_id&#39; is common for all metrics for one run.</span>
 <span class="sd">Currently it is possible to have following metrics types:</span>
 <span class="sd">* runtime</span>
 <span class="sd">* total_bytes_count</span>
 <span class="sd">&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">json</span>
 <span class="kn">import</span> <span class="nn">logging</span>
 <span class="kn">import</span> <span class="nn">time</span>
 <span class="kn">import</span> <span class="nn">uuid</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Mapping</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>

 <span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
 <span class="kn">import</span> <span class="nn">requests</span>
 <span class="kn">from</span> <span class="nn">requests.auth</span> <span class="kn">import</span> <span class="n">HTTPBasicAuth</span>

 <span class="kn">import</span> <span class="nn">apache_beam</span> <span class="k">as</span> <span class="nn">beam</span>
 <span class="kn">from</span> <span class="nn">apache_beam.metrics</span> <span class="kn">import</span> <span class="n">Metrics</span>
 <span class="kn">from</span> <span class="nn">apache_beam.metrics.metric</span> <span class="kn">import</span> <span class="n">MetricResults</span>
 <span class="kn">from</span> <span class="nn">apache_beam.metrics.metric</span> <span class="kn">import</span> <span class="n">MetricsFilter</span>
 <span class="kn">from</span> <span class="nn">apache_beam.runners.runner</span> <span class="kn">import</span> <span class="n">PipelineResult</span>
 <span class="kn">from</span> <span class="nn">apache_beam.transforms.window</span> <span class="kn">import</span> <span class="n">TimestampedValue</span>
 <span class="kn">from</span> <span class="nn">apache_beam.utils.timestamp</span> <span class="kn">import</span> <span class="n">Timestamp</span>

 <span class="k">try</span><span class="p">:</span>
   <span class="kn">from</span> <span class="nn">google.cloud</span> <span class="kn">import</span> <span class="n">bigquery</span>
   <span class="kn">from</span> <span class="nn">google.cloud.bigquery.schema</span> <span class="kn">import</span> <span class="n">SchemaField</span>
   <span class="kn">from</span> <span class="nn">google.cloud.exceptions</span> <span class="kn">import</span> <span class="n">NotFound</span>
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
   <span class="n">bigquery</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
   <span class="n">SchemaField</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
   <span class="n">NotFound</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>

 <span class="n">RUNTIME_METRIC</span> <span class="o">=</span> <span class="s1">&#39;runtime&#39;</span>
 <span class="n">COUNTER_LABEL</span> <span class="o">=</span> <span class="s1">&#39;total_bytes_count&#39;</span>

 <span class="n">ID_LABEL</span> <span class="o">=</span> <span class="s1">&#39;test_id&#39;</span>
 <span class="n">SUBMIT_TIMESTAMP_LABEL</span> <span class="o">=</span> <span class="s1">&#39;timestamp&#39;</span>
 <span class="n">METRICS_TYPE_LABEL</span> <span class="o">=</span> <span class="s1">&#39;metric&#39;</span>
 <span class="n">VALUE_LABEL</span> <span class="o">=</span> <span class="s1">&#39;value&#39;</span>

 <span class="n">SCHEMA</span> <span class="o">=</span> <span class="p">[{</span>
     <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">ID_LABEL</span><span class="p">,</span> <span class="s1">&#39;field_type&#39;</span><span class="p">:</span> <span class="s1">&#39;STRING&#39;</span><span class="p">,</span> <span class="s1">&#39;mode&#39;</span><span class="p">:</span> <span class="s1">&#39;REQUIRED&#39;</span>
 <span class="p">},</span>
           <span class="p">{</span>
               <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">SUBMIT_TIMESTAMP_LABEL</span><span class="p">,</span>
               <span class="s1">&#39;field_type&#39;</span><span class="p">:</span> <span class="s1">&#39;TIMESTAMP&#39;</span><span class="p">,</span>
               <span class="s1">&#39;mode&#39;</span><span class="p">:</span> <span class="s1">&#39;REQUIRED&#39;</span>
           <span class="p">},</span>
           <span class="p">{</span>
               <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">METRICS_TYPE_LABEL</span><span class="p">,</span>
               <span class="s1">&#39;field_type&#39;</span><span class="p">:</span> <span class="s1">&#39;STRING&#39;</span><span class="p">,</span>
               <span class="s1">&#39;mode&#39;</span><span class="p">:</span> <span class="s1">&#39;REQUIRED&#39;</span>
           <span class="p">},</span> <span class="p">{</span>
               <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">VALUE_LABEL</span><span class="p">,</span> <span class="s1">&#39;field_type&#39;</span><span class="p">:</span> <span class="s1">&#39;FLOAT&#39;</span><span class="p">,</span> <span class="s1">&#39;mode&#39;</span><span class="p">:</span> <span class="s1">&#39;REQUIRED&#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="parse_step"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.parse_step">[docs]</a><span class="k">def</span> <span class="nf">parse_step</span><span class="p">(</span><span class="n">step_name</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Replaces white spaces and removes &#39;Step:&#39; label</span>

 <span class="sd">  Args:</span>
 <span class="sd">    step_name(str): step name passed in metric ParDo</span>

 <span class="sd">  Returns:</span>
 <span class="sd">    lower case step name without namespace and step label</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">prefix</span> <span class="o">=</span> <span class="s1">&#39;step&#39;</span>
   <span class="n">step_name</span> <span class="o">=</span> <span class="n">step_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39; &#39;</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">)</span>
   <span class="n">step_name</span> <span class="o">=</span> <span class="p">(</span>
       <span class="n">step_name</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">):]</span>
       <span class="k">if</span> <span class="n">prefix</span> <span class="ow">and</span> <span class="n">step_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="k">else</span> <span class="n">step_name</span><span class="p">)</span>
   <span class="k">return</span> <span class="n">step_name</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">&#39;:_&#39;</span><span class="p">)</span></div>


 <div class="viewcode-block" id="split_metrics_by_namespace_and_name"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.split_metrics_by_namespace_and_name">[docs]</a><span class="k">def</span> <span class="nf">split_metrics_by_namespace_and_name</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Splits metrics list namespace and name.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    metrics: list of metrics from pipeline result</span>
 <span class="sd">    namespace(str): filter metrics by namespace</span>
 <span class="sd">    name(str): filter metrics by name</span>

 <span class="sd">  Returns:</span>
 <span class="sd">    two lists - one of metrics which are matching filters</span>
 <span class="sd">    and second of not matching</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">matching_metrics</span> <span class="o">=</span> <span class="p">[]</span>
   <span class="n">not_matching_metrics</span> <span class="o">=</span> <span class="p">[]</span>
   <span class="k">for</span> <span class="n">dist</span> <span class="ow">in</span> <span class="n">metrics</span><span class="p">:</span>
     <span class="k">if</span> <span class="n">dist</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span> <span class="o">==</span> <span class="n">namespace</span>\
         <span class="ow">and</span> <span class="n">dist</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">name</span><span class="p">:</span>
       <span class="n">matching_metrics</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dist</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="n">not_matching_metrics</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dist</span><span class="p">)</span>
   <span class="k">return</span> <span class="n">matching_metrics</span><span class="p">,</span> <span class="n">not_matching_metrics</span></div>


 <div class="viewcode-block" id="get_generic_distributions"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.get_generic_distributions">[docs]</a><span class="k">def</span> <span class="nf">get_generic_distributions</span><span class="p">(</span><span class="n">generic_dists</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Creates flatten list of distributions per its value type.</span>
 <span class="sd">  A generic distribution is the one which is not processed but saved in</span>
 <span class="sd">  the most raw version.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    generic_dists: list of distributions to be saved</span>
 <span class="sd">    metric_id(uuid): id of the current test run</span>

 <span class="sd">  Returns:</span>
 <span class="sd">    list of dictionaries made from :class:`DistributionMetric`</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">return</span> <span class="nb">sum</span><span class="p">((</span>
       <span class="n">get_all_distributions_by_type</span><span class="p">(</span><span class="n">dist</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">)</span> <span class="k">for</span> <span class="n">dist</span> <span class="ow">in</span> <span class="n">generic_dists</span><span class="p">),</span>
              <span class="p">[])</span></div>


 <div class="viewcode-block" id="get_all_distributions_by_type"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.get_all_distributions_by_type">[docs]</a><span class="k">def</span> <span class="nf">get_all_distributions_by_type</span><span class="p">(</span><span class="n">dist</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Creates new list of objects with type of each distribution</span>
 <span class="sd">  metric value.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    dist(object): DistributionMetric object to be parsed</span>
 <span class="sd">    metric_id(uuid): id of the current test run</span>
 <span class="sd">  Returns:</span>
 <span class="sd">    list of :class:`DistributionMetric` objects</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">submit_timestamp</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
   <span class="n">dist_types</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">,</span> <span class="s1">&#39;max&#39;</span><span class="p">,</span> <span class="s1">&#39;min&#39;</span><span class="p">,</span> <span class="s1">&#39;sum&#39;</span><span class="p">,</span> <span class="s1">&#39;mean&#39;</span><span class="p">]</span>
   <span class="n">distribution_dicts</span> <span class="o">=</span> <span class="p">[]</span>
   <span class="k">for</span> <span class="n">dist_type</span> <span class="ow">in</span> <span class="n">dist_types</span><span class="p">:</span>
     <span class="k">try</span><span class="p">:</span>
       <span class="n">distribution_dicts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
           <span class="n">get_distribution_dict</span><span class="p">(</span><span class="n">dist_type</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">))</span>
     <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
       <span class="c1"># Ignore metrics with &#39;None&#39; values.</span>
       <span class="k">continue</span>
   <span class="k">return</span> <span class="n">distribution_dicts</span></div>


 <div class="viewcode-block" id="get_distribution_dict"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.get_distribution_dict">[docs]</a><span class="k">def</span> <span class="nf">get_distribution_dict</span><span class="p">(</span><span class="n">metric_type</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">dist</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Function creates :class:`DistributionMetric`</span>

 <span class="sd">  Args:</span>
 <span class="sd">    metric_type(str): type of value from distribution metric which will</span>
 <span class="sd">      be saved (ex. max, min, mean, sum)</span>
 <span class="sd">    submit_timestamp: timestamp when metric is saved</span>
 <span class="sd">    dist(object) distribution object from pipeline result</span>
 <span class="sd">    metric_id(uuid): id of the current test run</span>

 <span class="sd">  Returns:</span>
 <span class="sd">    dictionary prepared for saving according to schema</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">return</span> <span class="n">DistributionMetric</span><span class="p">(</span><span class="n">dist</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span>
                             <span class="n">metric_type</span><span class="p">)</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span></div>


 <div class="viewcode-block" id="MetricsReader"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader">[docs]</a><span class="k">class</span> <span class="nc">MetricsReader</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  A :class:`MetricsReader` retrieves metrics from pipeline result,</span>
 <span class="sd">  prepares it for publishers and setup publishers.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">project_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">bq_table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">bq_dataset</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">publish_to_bq</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
       <span class="n">influxdb_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>  <span class="c1"># type: Optional[InfluxDBMetricsPublisherOptions]</span>
       <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">filters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initializes :class:`MetricsReader` .</span>

 <span class="sd">    Args:</span>
 <span class="sd">      project_name (str): project with BigQuery where metrics will be saved</span>
 <span class="sd">      bq_table (str): BigQuery table where metrics will be saved</span>
 <span class="sd">      bq_dataset (str): BigQuery dataset where metrics will be saved</span>
 <span class="sd">      namespace (str): Namespace of the metrics</span>
 <span class="sd">      filters: MetricFilter to query only filtered metrics</span>
 <span class="sd">    &quot;&quot;&quot;</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">publishers</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">MetricsPublisher</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="c1"># publish to console output</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">publishers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ConsoleMetricsPublisher</span><span class="p">())</span>

     <span class="n">bq_check</span> <span class="o">=</span> <span class="n">project_name</span> <span class="ow">and</span> <span class="n">bq_table</span> <span class="ow">and</span> <span class="n">bq_dataset</span> <span class="ow">and</span> <span class="n">publish_to_bq</span>
     <span class="k">if</span> <span class="n">bq_check</span><span class="p">:</span>
       <span class="c1"># publish to BigQuery</span>
       <span class="n">bq_publisher</span> <span class="o">=</span> <span class="n">BigQueryMetricsPublisher</span><span class="p">(</span>
           <span class="n">project_name</span><span class="p">,</span> <span class="n">bq_table</span><span class="p">,</span> <span class="n">bq_dataset</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">publishers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">bq_publisher</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">influxdb_options</span> <span class="ow">and</span> <span class="n">influxdb_options</span><span class="o">.</span><span class="n">validate</span><span class="p">():</span>
       <span class="c1"># publish to InfluxDB</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">publishers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">InfluxDBMetricsPublisher</span><span class="p">(</span><span class="n">influxdb_options</span><span class="p">))</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
           <span class="s1">&#39;Missing InfluxDB options. Metrics will not be published to &#39;</span>
           <span class="s1">&#39;InfluxDB&#39;</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">filters</span> <span class="o">=</span> <span class="n">filters</span>

 <div class="viewcode-block" id="MetricsReader.get_counter_metric"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.get_counter_metric">[docs]</a>  <span class="k">def</span> <span class="nf">get_counter_metric</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">PipelineResult</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="nb">int</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Return the current value for a long counter, or -1 if can&#39;t be retrieved.</span>
 <span class="sd">    Note this uses only attempted metrics because some runners don&#39;t support</span>
 <span class="sd">    committed metrics.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">filters</span> <span class="o">=</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="bp">self</span><span class="o">.</span><span class="n">_namespace</span><span class="p">)</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="n">counters</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">query</span><span class="p">(</span><span class="n">filters</span><span class="p">)[</span><span class="n">MetricResults</span><span class="o">.</span><span class="n">COUNTERS</span><span class="p">]</span>
     <span class="n">num_results</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">counters</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">num_results</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
           <span class="sa">f</span><span class="s2">&quot;More than one metric result matches name: </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> in namespace &quot;</span>\
           <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span><span class="si">}</span><span class="s2">. Metric results count: </span><span class="si">{</span><span class="n">num_results</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
     <span class="k">elif</span> <span class="n">num_results</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
       <span class="k">return</span> <span class="o">-</span><span class="mi">1</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">counters</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">attempted</span></div>

 <div class="viewcode-block" id="MetricsReader.publish_metrics"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_metrics">[docs]</a>  <span class="k">def</span> <span class="nf">publish_metrics</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">PipelineResult</span><span class="p">,</span> <span class="n">extra_metrics</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Publish metrics from pipeline result to registered publishers.&quot;&quot;&quot;</span>
     <span class="n">metric_id</span> <span class="o">=</span> <span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span><span class="o">.</span><span class="n">hex</span>
     <span class="n">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">query</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filters</span><span class="p">)</span>

     <span class="c1"># Metrics from pipeline result are stored in map with keys: &#39;gauges&#39;,</span>
     <span class="c1"># &#39;distributions&#39; and &#39;counters&#39;.</span>
     <span class="c1"># Under each key there is list of objects of each metric type. It is</span>
     <span class="c1"># required to prepare metrics for publishing purposes. Expected is to have</span>
     <span class="c1"># a list of dictionaries matching the schema.</span>
     <span class="n">insert_dicts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prepare_all_metrics</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">)</span>

     <span class="n">insert_dicts</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prepare_extra_metrics</span><span class="p">(</span><span class="n">metric_id</span><span class="p">,</span> <span class="n">extra_metrics</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">insert_dicts</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
       <span class="k">for</span> <span class="n">publisher</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">publishers</span><span class="p">:</span>
         <span class="n">publisher</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">insert_dicts</span><span class="p">)</span></div>

   <span class="k">def</span> <span class="nf">_prepare_extra_metrics</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">extra_metrics</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
     <span class="n">ts</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">extra_metrics</span><span class="p">:</span>
       <span class="n">extra_metrics</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">return</span> <span class="p">[</span>
         <span class="n">Metric</span><span class="p">(</span><span class="n">ts</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">k</span><span class="p">)</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span>
         <span class="n">v</span> <span class="ow">in</span> <span class="n">extra_metrics</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
     <span class="p">]</span>

 <div class="viewcode-block" id="MetricsReader.publish_values"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_values">[docs]</a>  <span class="k">def</span> <span class="nf">publish_values</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">labeled_values</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;The method to publish simple labeled values.</span>

 <span class="sd">    Args:</span>
 <span class="sd">      labeled_values (List[Tuple(str, int)]): list of (label, value)</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">metric_dicts</span> <span class="o">=</span> <span class="p">[</span>
         <span class="n">Metric</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span><span class="o">.</span><span class="n">hex</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">label</span><span class="p">)</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
         <span class="k">for</span> <span class="n">label</span><span class="p">,</span>
         <span class="n">value</span> <span class="ow">in</span> <span class="n">labeled_values</span>
     <span class="p">]</span>

     <span class="k">for</span> <span class="n">publisher</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">publishers</span><span class="p">:</span>
       <span class="n">publisher</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">metric_dicts</span><span class="p">)</span></div>

   <span class="k">def</span> <span class="nf">_prepare_all_metrics</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metrics</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>

     <span class="n">insert_rows</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_counters</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">&#39;counters&#39;</span><span class="p">],</span> <span class="n">metric_id</span><span class="p">)</span>
     <span class="n">insert_rows</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_distributions</span><span class="p">(</span><span class="n">metrics</span><span class="p">[</span><span class="s1">&#39;distributions&#39;</span><span class="p">],</span> <span class="n">metric_id</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">insert_rows</span>

   <span class="k">def</span> <span class="nf">_get_counters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">counters</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
     <span class="n">submit_timestamp</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
     <span class="k">return</span> <span class="p">[</span>
         <span class="n">CounterMetric</span><span class="p">(</span><span class="n">counter</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">)</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
         <span class="k">for</span> <span class="n">counter</span> <span class="ow">in</span> <span class="n">counters</span>
     <span class="p">]</span>

   <span class="k">def</span> <span class="nf">_get_distributions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">distributions</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
     <span class="n">rows</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">matching_namsespace</span><span class="p">,</span> <span class="n">not_matching_namespace</span> <span class="o">=</span> \
       <span class="n">split_metrics_by_namespace_and_name</span><span class="p">(</span><span class="n">distributions</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="n">RUNTIME_METRIC</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">matching_namsespace</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
       <span class="n">runtime_metric</span> <span class="o">=</span> <span class="n">RuntimeMetric</span><span class="p">(</span><span class="n">matching_namsespace</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">)</span>
       <span class="n">rows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">runtime_metric</span><span class="o">.</span><span class="n">as_dict</span><span class="p">())</span>
     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">not_matching_namespace</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
       <span class="n">rows</span> <span class="o">+=</span> <span class="n">get_generic_distributions</span><span class="p">(</span><span class="n">not_matching_namespace</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">rows</span></div>


 <div class="viewcode-block" id="Metric"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.Metric">[docs]</a><span class="k">class</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;Metric base class in ready-to-save format.&quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">metric</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initializes :class:`Metric`</span>

 <span class="sd">    Args:</span>
 <span class="sd">      metric (object): object of metric result</span>
 <span class="sd">      submit_timestamp (float): date-time of saving metric to database</span>
 <span class="sd">      metric_id (uuid): unique id to identify test run</span>
 <span class="sd">      value: value of metric</span>
 <span class="sd">      label: custom metric name to be saved in database</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">submit_timestamp</span> <span class="o">=</span> <span class="n">submit_timestamp</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">metric_id</span> <span class="o">=</span> <span class="n">metric_id</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="n">label</span> <span class="ow">or</span> <span class="n">metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span> <span class="o">+</span> \
             <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">parse_step</span><span class="p">(</span><span class="n">metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">step</span><span class="p">)</span> <span class="o">+</span> \
             <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">name</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span>

 <div class="viewcode-block" id="Metric.as_dict"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.Metric.as_dict">[docs]</a>  <span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">{</span>
         <span class="n">SUBMIT_TIMESTAMP_LABEL</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">submit_timestamp</span><span class="p">,</span>
         <span class="n">ID_LABEL</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">metric_id</span><span class="p">,</span>
         <span class="n">VALUE_LABEL</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">,</span>
         <span class="n">METRICS_TYPE_LABEL</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">label</span>
     <span class="p">}</span></div></div>


 <div class="viewcode-block" id="CounterMetric"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.CounterMetric">[docs]</a><span class="k">class</span> <span class="nc">CounterMetric</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;The Counter Metric in ready-to-publish format.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    counter_metric (object): counter metric object from MetricResult</span>
 <span class="sd">    submit_timestamp (float): date-time of saving metric to database</span>
 <span class="sd">    metric_id (uuid): unique id to identify test run</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">counter_metric</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
     <span class="n">value</span> <span class="o">=</span> <span class="n">counter_metric</span><span class="o">.</span><span class="n">result</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">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">counter_metric</span><span class="p">)</span></div>


 <div class="viewcode-block" id="DistributionMetric"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric">[docs]</a><span class="k">class</span> <span class="nc">DistributionMetric</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;The Distribution Metric in ready-to-publish format.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    dist_metric (object): distribution metric object from MetricResult</span>
 <span class="sd">    submit_timestamp (float): date-time of saving metric to database</span>
 <span class="sd">    metric_id (uuid): unique id to identify test run</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dist_metric</span><span class="p">,</span> <span class="n">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">metric_type</span><span class="p">):</span>
     <span class="n">custom_label</span> <span class="o">=</span> <span class="n">dist_metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span> <span class="o">+</span> \
                    <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">parse_step</span><span class="p">(</span><span class="n">dist_metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">step</span><span class="p">)</span> <span class="o">+</span> \
                    <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">metric_type</span> <span class="o">+</span> \
                    <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">dist_metric</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">name</span>
     <span class="n">value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">dist_metric</span><span class="o">.</span><span class="n">result</span><span class="p">,</span> <span class="n">metric_type</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
       <span class="n">msg</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">: the result is expected to be an integer, &#39;</span> \
             <span class="s1">&#39;not None.&#39;</span> <span class="o">%</span> <span class="n">custom_label</span>
       <span class="n">_LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</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">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">dist_metric</span><span class="p">,</span> <span class="n">custom_label</span><span class="p">)</span></div>


 <div class="viewcode-block" id="RuntimeMetric"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.RuntimeMetric">[docs]</a><span class="k">class</span> <span class="nc">RuntimeMetric</span><span class="p">(</span><span class="n">Metric</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;The Distribution Metric in ready-to-publish format.</span>

 <span class="sd">  Args:</span>
 <span class="sd">    runtime_list: list of distributions metrics from MetricResult</span>
 <span class="sd">      with runtime name</span>
 <span class="sd">    metric_id(uuid): unique id to identify test run</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">runtime_list</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">):</span>
     <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prepare_runtime_metrics</span><span class="p">(</span><span class="n">runtime_list</span><span class="p">)</span>
     <span class="n">submit_timestamp</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
     <span class="c1"># Label does not include step name, because it is one value calculated</span>
     <span class="c1"># out of many steps</span>
     <span class="n">label</span> <span class="o">=</span> <span class="n">runtime_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span> <span class="o">+</span> \
             <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">RUNTIME_METRIC</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">submit_timestamp</span><span class="p">,</span> <span class="n">metric_id</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">label</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_prepare_runtime_metrics</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">distributions</span><span class="p">):</span>
     <span class="n">min_values</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">max_values</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="k">for</span> <span class="n">dist</span> <span class="ow">in</span> <span class="n">distributions</span><span class="p">:</span>
       <span class="n">min_values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dist</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">min</span><span class="p">)</span>
       <span class="n">max_values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dist</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">max</span><span class="p">)</span>
     <span class="c1"># finding real start</span>
     <span class="n">min_value</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">min_values</span><span class="p">)</span>
     <span class="c1"># finding real end</span>
     <span class="n">max_value</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">max_values</span><span class="p">)</span>

     <span class="n">runtime_in_s</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">max_value</span> <span class="o">-</span> <span class="n">min_value</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">runtime_in_s</span></div>


 <div class="viewcode-block" id="MetricsPublisher"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher">[docs]</a><span class="k">class</span> <span class="nc">MetricsPublisher</span><span class="p">:</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Base class for metrics publishers.&quot;&quot;&quot;</span>
 <div class="viewcode-block" id="MetricsPublisher.publish"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher.publish">[docs]</a>  <span class="k">def</span> <span class="nf">publish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="k">raise</span> <span class="ne">NotImplementedError</span></div></div>


 <div class="viewcode-block" id="ConsoleMetricsPublisher"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher">[docs]</a><span class="k">class</span> <span class="nc">ConsoleMetricsPublisher</span><span class="p">(</span><span class="n">MetricsPublisher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A :class:`ConsoleMetricsPublisher` publishes collected metrics</span>
 <span class="sd">  to console output.&quot;&quot;&quot;</span>
 <div class="viewcode-block" id="ConsoleMetricsPublisher.publish"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher.publish">[docs]</a>  <span class="k">def</span> <span class="nf">publish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
       <span class="n">log</span> <span class="o">=</span> <span class="s2">&quot;Load test results for test: </span><span class="si">%s</span><span class="s2"> and timestamp: </span><span class="si">%s</span><span class="s2">:&quot;</span> \
             <span class="o">%</span> <span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="n">ID_LABEL</span><span class="p">],</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="n">SUBMIT_TIMESTAMP_LABEL</span><span class="p">])</span>
       <span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">log</span><span class="p">)</span>
       <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span>
         <span class="n">log</span> <span class="o">=</span> <span class="s2">&quot;Metric: </span><span class="si">%s</span><span class="s2"> Value: </span><span class="si">%d</span><span class="s2">&quot;</span> \
               <span class="o">%</span> <span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="n">METRICS_TYPE_LABEL</span><span class="p">],</span> <span class="n">result</span><span class="p">[</span><span class="n">VALUE_LABEL</span><span class="p">])</span>
         <span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">log</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;No test results were collected.&quot;</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="BigQueryMetricsPublisher"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher">[docs]</a><span class="k">class</span> <span class="nc">BigQueryMetricsPublisher</span><span class="p">(</span><span class="n">MetricsPublisher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A :class:`BigQueryMetricsPublisher` publishes collected metrics</span>
 <span class="sd">  to BigQuery output.&quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_name</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">dataset</span><span class="p">,</span> <span class="n">bq_schema</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">bq_schema</span><span class="p">:</span>
       <span class="n">bq_schema</span> <span class="o">=</span> <span class="n">SCHEMA</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bq</span> <span class="o">=</span> <span class="n">BigQueryClient</span><span class="p">(</span><span class="n">project_name</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">dataset</span><span class="p">,</span> <span class="n">bq_schema</span><span class="p">)</span>

 <div class="viewcode-block" id="BigQueryMetricsPublisher.publish"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher.publish">[docs]</a>  <span class="k">def</span> <span class="nf">publish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="n">outputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">bq</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">outputs</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
       <span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="n">outputs</span><span class="p">:</span>
         <span class="k">if</span> <span class="n">output</span><span class="p">[</span><span class="s1">&#39;errors&#39;</span><span class="p">]:</span>
           <span class="n">_LOGGER</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">output</span><span class="p">)</span>
           <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
               <span class="s1">&#39;Unable save rows in BigQuery: </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">output</span><span class="p">[</span><span class="s1">&#39;errors&#39;</span><span class="p">]))</span></div></div>


 <div class="viewcode-block" id="BigQueryClient"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient">[docs]</a><span class="k">class</span> <span class="nc">BigQueryClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A :class:`BigQueryClient` publishes collected metrics to</span>
 <span class="sd">  BigQuery output.&quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_name</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">dataset</span><span class="p">,</span> <span class="n">bq_schema</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">bq_schema</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span> <span class="o">=</span> <span class="n">table</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">bigquery</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="n">project_name</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_schema_names</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_schema_names</span><span class="p">()</span>
     <span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_prepare_schema</span><span class="p">()</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">_get_or_create_table</span><span class="p">(</span><span class="n">schema</span><span class="p">,</span> <span class="n">dataset</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_get_schema_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">[</span><span class="n">schema</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">schema</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">]</span>

   <span class="k">def</span> <span class="nf">_prepare_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">[</span><span class="n">SchemaField</span><span class="p">(</span><span class="o">**</span><span class="n">row</span><span class="p">)</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">]</span>

   <span class="k">def</span> <span class="nf">_get_or_create_table</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bq_schemas</span><span class="p">,</span> <span class="n">dataset</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Namespace cannot be empty.&#39;</span><span class="p">)</span>

     <span class="n">dataset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_dataset</span><span class="p">(</span><span class="n">dataset</span><span class="p">)</span>
     <span class="n">table_ref</span> <span class="o">=</span> <span class="n">dataset</span><span class="o">.</span><span class="n">table</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="k">try</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_bq_table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">get_table</span><span class="p">(</span><span class="n">table_ref</span><span class="p">)</span>
     <span class="k">except</span> <span class="n">NotFound</span><span class="p">:</span>
       <span class="n">table</span> <span class="o">=</span> <span class="n">bigquery</span><span class="o">.</span><span class="n">Table</span><span class="p">(</span><span class="n">table_ref</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">bq_schemas</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">_bq_table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_get_dataset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dataset_name</span><span class="p">):</span>
     <span class="n">bq_dataset_ref</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">dataset</span><span class="p">(</span><span class="n">dataset_name</span><span class="p">)</span>
     <span class="k">try</span><span class="p">:</span>
       <span class="n">bq_dataset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">get_dataset</span><span class="p">(</span><span class="n">bq_dataset_ref</span><span class="p">)</span>
     <span class="k">except</span> <span class="n">NotFound</span><span class="p">:</span>
       <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
           <span class="s1">&#39;Dataset </span><span class="si">{}</span><span class="s1"> does not exist in your project. &#39;</span>
           <span class="s1">&#39;You have to create table first.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">dataset_name</span><span class="p">))</span>
     <span class="k">return</span> <span class="n">bq_dataset</span>

 <div class="viewcode-block" id="BigQueryClient.save"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient.save">[docs]</a>  <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">insert_rows</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_bq_table</span><span class="p">,</span> <span class="n">results</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="InfluxDBMetricsPublisherOptions"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions">[docs]</a><span class="k">class</span> <span class="nc">InfluxDBMetricsPublisherOptions</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">measurement</span><span class="p">,</span>  <span class="c1"># type: str</span>
       <span class="n">db_name</span><span class="p">,</span>  <span class="c1"># type: str</span>
       <span class="n">hostname</span><span class="p">,</span>  <span class="c1"># type: str</span>
       <span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>  <span class="c1"># type: Optional[str]</span>
       <span class="n">password</span><span class="o">=</span><span class="kc">None</span>  <span class="c1"># type: Optional[str]</span>
     <span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">measurement</span> <span class="o">=</span> <span class="n">measurement</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">db_name</span> <span class="o">=</span> <span class="n">db_name</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">hostname</span> <span class="o">=</span> <span class="n">hostname</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span>

 <div class="viewcode-block" id="InfluxDBMetricsPublisherOptions.validate"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.validate">[docs]</a>  <span class="k">def</span> <span class="nf">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="c1"># type: () -&gt; bool</span>
     <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">measurement</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_name</span><span class="p">)</span></div>

 <div class="viewcode-block" id="InfluxDBMetricsPublisherOptions.http_auth_enabled"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.http_auth_enabled">[docs]</a>  <span class="k">def</span> <span class="nf">http_auth_enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="c1"># type: () -&gt; bool</span>
     <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div></div>


 <div class="viewcode-block" id="InfluxDBMetricsPublisher"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher">[docs]</a><span class="k">class</span> <span class="nc">InfluxDBMetricsPublisher</span><span class="p">(</span><span class="n">MetricsPublisher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Publishes collected metrics to InfluxDB database.&quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
       <span class="bp">self</span><span class="p">,</span>
       <span class="n">options</span>  <span class="c1"># type: InfluxDBMetricsPublisherOptions</span>
   <span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="n">options</span>

 <div class="viewcode-block" id="InfluxDBMetricsPublisher.publish"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher.publish">[docs]</a>  <span class="k">def</span> <span class="nf">publish</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="c1"># type: (List[Mapping[str, Union[float, str, int]]]) -&gt; None</span>
     <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">/write&#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">options</span><span class="o">.</span><span class="n">hostname</span><span class="p">)</span>
     <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_build_payload</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
     <span class="n">query_str</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;db&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">db_name</span><span class="p">,</span> <span class="s1">&#39;precision&#39;</span><span class="p">:</span> <span class="s1">&#39;s&#39;</span><span class="p">}</span>

     <span class="n">auth</span> <span class="o">=</span> <span class="n">HTTPBasicAuth</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">user</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> <span class="k">if</span> \
       <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">http_auth_enabled</span><span class="p">()</span> <span class="k">else</span> <span class="kc">None</span>

     <span class="k">try</span><span class="p">:</span>
       <span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">query_str</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">payload</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="n">auth</span><span class="p">)</span>
     <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">RequestException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
       <span class="n">_LOGGER</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">&#39;Failed to publish metrics to InfluxDB: &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">204</span><span class="p">:</span>
         <span class="n">content</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">)</span>
         <span class="n">_LOGGER</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
             <span class="s1">&#39;Failed to publish metrics to InfluxDB. Received status code </span><span class="si">%s</span><span class="s1"> &#39;</span>
             <span class="s1">&#39;with an error message: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span>
             <span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span> <span class="n">content</span><span class="p">[</span><span class="s1">&#39;error&#39;</span><span class="p">]))</span></div>

   <span class="k">def</span> <span class="nf">_build_payload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
     <span class="c1"># type: (List[Mapping[str, Union[float, str, int]]]) -&gt; str</span>
     <span class="k">def</span> <span class="nf">build_kv</span><span class="p">(</span><span class="n">mapping</span><span class="p">,</span> <span class="n">key</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">key</span><span class="p">,</span> <span class="n">mapping</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>

     <span class="n">points</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span>
       <span class="n">comma_separated</span> <span class="o">=</span> <span class="p">[</span>
           <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">measurement</span><span class="p">,</span>
           <span class="n">build_kv</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">METRICS_TYPE_LABEL</span><span class="p">),</span>
           <span class="n">build_kv</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">ID_LABEL</span><span class="p">),</span>
       <span class="p">]</span>
       <span class="n">point</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="n">comma_separated</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; &#39;</span> <span class="o">+</span> <span class="n">build_kv</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">VALUE_LABEL</span><span class="p">)</span> \
               <span class="o">+</span> <span class="s1">&#39; &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="n">SUBMIT_TIMESTAMP_LABEL</span><span class="p">]))</span>
       <span class="n">points</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">point</span><span class="p">)</span>
     <span class="k">return</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">points</span><span class="p">)</span></div>


 <div class="viewcode-block" id="MeasureTime"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime">[docs]</a><span class="k">class</span> <span class="nc">MeasureTime</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A distribution metric prepared to be added to pipeline as ParDo</span>
 <span class="sd">   to measure runtime.&quot;&quot;&quot;</span>
   <span class="k">def</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="w">    </span><span class="sd">&quot;&quot;&quot;Initializes :class:`MeasureTime`.</span>

 <span class="sd">      namespace(str): namespace of  metric</span>
 <span class="sd">    &quot;&quot;&quot;</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">runtime</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">distribution</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="n">RUNTIME_METRIC</span><span class="p">)</span>

 <div class="viewcode-block" id="MeasureTime.start_bundle"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.start_bundle">[docs]</a>  <span class="k">def</span> <span class="nf">start_bundle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">runtime</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span></div>

 <div class="viewcode-block" id="MeasureTime.finish_bundle"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.finish_bundle">[docs]</a>  <span class="k">def</span> <span class="nf">finish_bundle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">runtime</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span></div>

 <div class="viewcode-block" id="MeasureTime.process"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.process">[docs]</a>  <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
     <span class="k">yield</span> <span class="n">element</span></div></div>


 <div class="viewcode-block" id="MeasureBytes"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes">[docs]</a><span class="k">class</span> <span class="nc">MeasureBytes</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Metric to measure how many bytes was observed in pipeline.&quot;&quot;&quot;</span>
   <span class="n">LABEL</span> <span class="o">=</span> <span class="s1">&#39;total_bytes&#39;</span>

   <span class="k">def</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">extractor</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initializes :class:`MeasureBytes`.</span>

 <span class="sd">    Args:</span>
 <span class="sd">      namespace(str): metric namespace</span>
 <span class="sd">      extractor: function to extract elements to be count</span>
 <span class="sd">    &quot;&quot;&quot;</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">counter</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">counter</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">LABEL</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">extractor</span> <span class="o">=</span> <span class="n">extractor</span> <span class="k">if</span> <span class="n">extractor</span> <span class="k">else</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="k">yield</span> <span class="n">x</span><span class="p">)</span>

 <div class="viewcode-block" id="MeasureBytes.process"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes.process">[docs]</a>  <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
     <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">extractor</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">counter</span><span class="o">.</span><span class="n">inc</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
     <span class="k">yield</span> <span class="n">element</span></div></div>


 <div class="viewcode-block" id="CountMessages"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages">[docs]</a><span class="k">class</span> <span class="nc">CountMessages</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
   <span class="n">LABEL</span> <span class="o">=</span> <span class="s1">&#39;total_messages&#39;</span>

   <span class="k">def</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="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">counter</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">counter</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">LABEL</span><span class="p">)</span>

 <div class="viewcode-block" id="CountMessages.process"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages.process">[docs]</a>  <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">counter</span><span class="o">.</span><span class="n">inc</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
     <span class="k">yield</span> <span class="n">element</span></div></div>


 <div class="viewcode-block" id="MeasureLatency"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency">[docs]</a><span class="k">class</span> <span class="nc">MeasureLatency</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A distribution metric which captures the latency based on the timestamps</span>
 <span class="sd">  of the processed elements.&quot;&quot;&quot;</span>
   <span class="n">LABEL</span> <span class="o">=</span> <span class="s1">&#39;latency&#39;</span>

   <span class="k">def</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="w">    </span><span class="sd">&quot;&quot;&quot;Initializes :class:`MeasureLatency`.</span>

 <span class="sd">      namespace(str): namespace of  metric</span>
 <span class="sd">    &quot;&quot;&quot;</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">latency_ms</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">distribution</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">LABEL</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">time_fn</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span>

 <div class="viewcode-block" id="MeasureLatency.process"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency.process">[docs]</a>  <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">timestamp</span><span class="o">=</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="o">.</span><span class="n">TimestampParam</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">latency_ms</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
         <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_fn</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span> <span class="o">-</span> <span class="p">(</span><span class="n">timestamp</span><span class="o">.</span><span class="n">micros</span> <span class="o">//</span> <span class="mi">1000</span><span class="p">))</span>
     <span class="k">yield</span> <span class="n">element</span></div></div>


 <div class="viewcode-block" id="AssignTimestamps"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps">[docs]</a><span class="k">class</span> <span class="nc">AssignTimestamps</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">DoFn</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;DoFn to assigned timestamps to elements.&quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="c1"># Avoid having to use save_main_session</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">time_fn</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_val_fn</span> <span class="o">=</span> <span class="n">TimestampedValue</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_fn</span> <span class="o">=</span> <span class="n">Timestamp</span>

 <div class="viewcode-block" id="AssignTimestamps.process"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps.process">[docs]</a>  <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
     <span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_val_fn</span><span class="p">(</span>
         <span class="n">element</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp_fn</span><span class="p">(</span><span class="n">micros</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_fn</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000000</span><span class="p">)))</span></div></div>


 <div class="viewcode-block" id="BigQueryMetricsFetcher"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsFetcher">[docs]</a><span class="k">class</span> <span class="nc">BigQueryMetricsFetcher</span><span class="p">:</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">bigquery</span><span class="o">.</span><span class="n">Client</span><span class="p">()</span>

 <div class="viewcode-block" id="BigQueryMetricsFetcher.fetch"><a class="viewcode-back" href="../../../../apache_beam.testing.load_tests.load_test_metrics_utils.html#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsFetcher.fetch">[docs]</a>  <span class="k">def</span> <span class="nf">fetch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
     <span class="n">query_job</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">)</span>
     <span class="n">result</span> <span class="o">=</span> <span class="n">query_job</span><span class="o">.</span><span class="n">result</span><span class="p">()</span>
     <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">to_dataframe</span><span class="p">()</span></div></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <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/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>