| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.testing.load_tests.load_test_metrics_utils module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.testing.datatype_inference module" href="apache_beam.testing.datatype_inference.html" /> |
| <link rel="prev" title="apache_beam.testing.load_tests.dataflow_cost_consts module" href="apache_beam.testing.load_tests.dataflow_cost_consts.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| Apache Beam |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><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 current"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.testing.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.benchmarks.html">apache_beam.testing.benchmarks package</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.testing.load_tests.html">apache_beam.testing.load_tests package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.testing.load_tests.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.testing.html">apache_beam.testing package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.testing.load_tests.html">apache_beam.testing.load_tests package</a></li> |
| <li class="breadcrumb-item active">apache_beam.testing.load_tests.load_test_metrics_utils module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.testing.load_tests.load_test_metrics_utils.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="module-apache_beam.testing.load_tests.load_test_metrics_utils"> |
| <span id="apache-beam-testing-load-tests-load-test-metrics-utils-module"></span><h1>apache_beam.testing.load_tests.load_test_metrics_utils module<a class="headerlink" href="#module-apache_beam.testing.load_tests.load_test_metrics_utils" title="Link to this heading"></a></h1> |
| <p>Utility functions used for integrating Metrics API into load tests pipelines.</p> |
| <p>Metrics are send to BigQuery in following format: |
| test_id | submit_timestamp | metric_type | value</p> |
| <p>The ‘test_id’ is common for all metrics for one run. |
| Currently it is possible to have following metrics types: |
| * runtime |
| * total_bytes_count</p> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.parse_step"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">parse_step</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#parse_step"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.parse_step" title="Link to this definition"></a></dt> |
| <dd><p>Replaces white spaces and removes ‘Step:’ label</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>step_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – step name passed in metric ParDo</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>lower case step name without namespace and step label</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.split_metrics_by_namespace_and_name"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">split_metrics_by_namespace_and_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metrics</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#split_metrics_by_namespace_and_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.split_metrics_by_namespace_and_name" title="Link to this definition"></a></dt> |
| <dd><p>Splits metrics list namespace and name.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metrics</strong> – list of metrics from pipeline result</p></li> |
| <li><p><strong>namespace</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – filter metrics by namespace</p></li> |
| <li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – filter metrics by name</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>two lists - one of metrics which are matching filters |
| and second of not matching</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.get_generic_distributions"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">get_generic_distributions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">generic_dists</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#get_generic_distributions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.get_generic_distributions" title="Link to this definition"></a></dt> |
| <dd><p>Creates flatten list of distributions per its value type. |
| A generic distribution is the one which is not processed but saved in |
| the most raw version.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>generic_dists</strong> – list of distributions to be saved</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – id of the current test run</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>list of dictionaries made from <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric" title="apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributionMetric</span></code></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.get_all_distributions_by_type"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">get_all_distributions_by_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dist</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#get_all_distributions_by_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.get_all_distributions_by_type" title="Link to this definition"></a></dt> |
| <dd><p>Creates new list of objects with type of each distribution |
| metric value.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dist</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – DistributionMetric object to be parsed</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – id of the current test run</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>list of <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric" title="apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributionMetric</span></code></a> objects</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.get_distribution_dict"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">get_distribution_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">submit_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#get_distribution_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.get_distribution_dict" title="Link to this definition"></a></dt> |
| <dd><p>Function creates <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric" title="apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributionMetric</span></code></a></p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metric_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – type of value from distribution metric which will |
| be saved (ex. max, min, mean, sum)</p></li> |
| <li><p><strong>submit_timestamp</strong> – timestamp when metric is saved</p></li> |
| <li><p><strong>dist</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>)</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – id of the current test run</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>dictionary prepared for saving according to schema</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">MetricsReader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bq_table</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bq_dataset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">publish_to_bq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">influxdb_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions" title="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions"><span class="pre">InfluxDBMetricsPublisherOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsReader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader" title="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsReader</span></code></a> retrieves metrics from pipeline result, |
| prepares it for publishers and setup publishers.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader" title="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsReader</span></code></a> .</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>project_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – project with BigQuery where metrics will be saved</p></li> |
| <li><p><strong>bq_table</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – BigQuery table where metrics will be saved</p></li> |
| <li><p><strong>bq_dataset</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – BigQuery dataset where metrics will be saved</p></li> |
| <li><p><strong>namespace</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Namespace of the metrics</p></li> |
| <li><p><strong>filters</strong> – MetricFilter to query only filtered metrics</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.get_counter_metric"> |
| <span class="sig-name descname"><span class="pre">get_counter_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><span class="pre">PipelineResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsReader.get_counter_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.get_counter_metric" title="Link to this definition"></a></dt> |
| <dd><p>Return the current value for a long counter, or -1 if can’t be retrieved. |
| Note this uses only attempted metrics because some runners don’t support |
| committed metrics.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_metrics"> |
| <span class="sig-name descname"><span class="pre">publish_metrics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><span class="pre">PipelineResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_metrics</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsReader.publish_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_metrics" title="Link to this definition"></a></dt> |
| <dd><p>Publish metrics from pipeline result to registered publishers.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_values"> |
| <span class="sig-name descname"><span class="pre">publish_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">labeled_values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsReader.publish_values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsReader.publish_values" title="Link to this definition"></a></dt> |
| <dd><p>The method to publish simple labeled values.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>labeled_values</strong> (<em>List</em><em>[</em><em>Tuple</em><em>(</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>)</em><em>]</em>) – list of (label, value)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.Metric"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">Metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">submit_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#Metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Metric base class in ready-to-save format.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric" title="apache_beam.testing.load_tests.load_test_metrics_utils.Metric"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metric</span></code></a></p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metric</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – object of metric result</p></li> |
| <li><p><strong>submit_timestamp</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – date-time of saving metric to database</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – unique id to identify test run</p></li> |
| <li><p><strong>value</strong> – value of metric</p></li> |
| <li><p><strong>label</strong> – custom metric name to be saved in database</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.Metric.as_dict"> |
| <span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#Metric.as_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric.as_dict" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.CounterMetric"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">CounterMetric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counter_metric</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">submit_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#CounterMetric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.CounterMetric" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric" title="apache_beam.testing.load_tests.load_test_metrics_utils.Metric"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metric</span></code></a></p> |
| <p>The Counter Metric in ready-to-publish format.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>counter_metric</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – counter metric object from MetricResult</p></li> |
| <li><p><strong>submit_timestamp</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – date-time of saving metric to database</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – unique id to identify test run</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">DistributionMetric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dist_metric</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">submit_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#DistributionMetric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.DistributionMetric" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric" title="apache_beam.testing.load_tests.load_test_metrics_utils.Metric"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metric</span></code></a></p> |
| <p>The Distribution Metric in ready-to-publish format.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dist_metric</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – distribution metric object from MetricResult</p></li> |
| <li><p><strong>submit_timestamp</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – date-time of saving metric to database</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – unique id to identify test run</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.RuntimeMetric"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">RuntimeMetric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#RuntimeMetric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.RuntimeMetric" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.Metric" title="apache_beam.testing.load_tests.load_test_metrics_utils.Metric"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metric</span></code></a></p> |
| <p>The Distribution Metric in ready-to-publish format.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>runtime_list</strong> – list of distributions metrics from MetricResult |
| with runtime name</p></li> |
| <li><p><strong>metric_id</strong> (<em>uuid</em>) – unique id to identify test run</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">MetricsPublisher</span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsPublisher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Base class for metrics publishers.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher.publish"> |
| <span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MetricsPublisher.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher.publish" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">ConsoleMetricsPublisher</span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#ConsoleMetricsPublisher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher" title="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsPublisher</span></code></a></p> |
| <p>A <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher" title="apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConsoleMetricsPublisher</span></code></a> publishes collected metrics |
| to console output.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher.publish"> |
| <span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#ConsoleMetricsPublisher.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.ConsoleMetricsPublisher.publish" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">BigQueryMetricsPublisher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bq_schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#BigQueryMetricsPublisher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher" title="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsPublisher</span></code></a></p> |
| <p>A <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher" title="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher"><code class="xref py py-class docutils literal notranslate"><span class="pre">BigQueryMetricsPublisher</span></code></a> publishes collected metrics |
| to BigQuery output.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher.publish"> |
| <span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#BigQueryMetricsPublisher.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryMetricsPublisher.publish" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">BigQueryClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bq_schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#BigQueryClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient" title="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">BigQueryClient</span></code></a> publishes collected metrics to |
| BigQuery output.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient.save"> |
| <span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#BigQueryClient.save"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.BigQueryClient.save" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">InfluxDBMetricsPublisherOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">measurement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#InfluxDBMetricsPublisherOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.validate"> |
| <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#InfluxDBMetricsPublisherOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.validate" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.http_auth_enabled"> |
| <span class="sig-name descname"><span class="pre">http_auth_enabled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#InfluxDBMetricsPublisherOptions.http_auth_enabled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions.http_auth_enabled" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">InfluxDBMetricsPublisher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions" title="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisherOptions"><span class="pre">InfluxDBMetricsPublisherOptions</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#InfluxDBMetricsPublisher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher" title="apache_beam.testing.load_tests.load_test_metrics_utils.MetricsPublisher"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsPublisher</span></code></a></p> |
| <p>Publishes collected metrics to InfluxDB database.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher.publish"> |
| <span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.13)"><span class="pre">Mapping</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#InfluxDBMetricsPublisher.publish"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.InfluxDBMetricsPublisher.publish" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">MeasureTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>A distribution metric prepared to be added to pipeline as ParDo |
| to measure runtime.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime" title="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">MeasureTime</span></code></a>.</p> |
| <p>namespace(str): namespace of metric</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.start_bundle"> |
| <span class="sig-name descname"><span class="pre">start_bundle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureTime.start_bundle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.start_bundle" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.finish_bundle"> |
| <span class="sig-name descname"><span class="pre">finish_bundle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureTime.finish_bundle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.finish_bundle" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureTime.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureTime.process" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">MeasureBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extractor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureBytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>Metric to measure how many bytes was observed in pipeline.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes" title="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">MeasureBytes</span></code></a>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>namespace</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – metric namespace</p></li> |
| <li><p><strong>extractor</strong> – function to extract elements to be count</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes.LABEL"> |
| <span class="sig-name descname"><span class="pre">LABEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'total_bytes'</span></em><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes.LABEL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureBytes.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureBytes.process" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">CountMessages</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#CountMessages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages.LABEL"> |
| <span class="sig-name descname"><span class="pre">LABEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'total_messages'</span></em><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages.LABEL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#CountMessages.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.CountMessages.process" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">MeasureLatency</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureLatency"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>A distribution metric which captures the latency based on the timestamps |
| of the processed elements.</p> |
| <p>Initializes <a class="reference internal" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency" title="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency"><code class="xref py py-class docutils literal notranslate"><span class="pre">MeasureLatency</span></code></a>.</p> |
| <p>namespace(str): namespace of metric</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency.LABEL"> |
| <span class="sig-name descname"><span class="pre">LABEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'latency'</span></em><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency.LABEL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">TimestampParam</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#MeasureLatency.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.MeasureLatency.process" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.load_tests.load_test_metrics_utils.</span></span><span class="sig-name descname"><span class="pre">AssignTimestamps</span></span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#AssignTimestamps"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>DoFn to assigned timestamps to elements.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/load_tests/load_test_metrics_utils.html#AssignTimestamps.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.load_tests.load_test_metrics_utils.AssignTimestamps.process" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.testing.load_tests.dataflow_cost_consts.html" class="btn btn-neutral float-left" title="apache_beam.testing.load_tests.dataflow_cost_consts module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.testing.datatype_inference.html" class="btn btn-neutral float-right" title="apache_beam.testing.datatype_inference module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
