| |
| |
| <!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.benchmarks.nexmark.nexmark_launcher module — Apache Beam 2.67.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=959b4fbe"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.testing.benchmarks.nexmark.nexmark_perf module" href="apache_beam.testing.benchmarks.nexmark.nexmark_perf.html" /> |
| <link rel="prev" title="apache_beam.testing.benchmarks.nexmark.monitor module" href="apache_beam.testing.benchmarks.nexmark.monitor.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 current"><a class="reference internal" href="apache_beam.testing.benchmarks.html">apache_beam.testing.benchmarks package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.testing.benchmarks.html#subpackages">Subpackages</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.load_tests.html">apache_beam.testing.load_tests package</a></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.benchmarks.html">apache_beam.testing.benchmarks package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.testing.benchmarks.nexmark.html">apache_beam.testing.benchmarks.nexmark package</a></li> |
| <li class="breadcrumb-item active">apache_beam.testing.benchmarks.nexmark.nexmark_launcher module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.testing.benchmarks.nexmark.nexmark_launcher.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.benchmarks.nexmark.nexmark_launcher"> |
| <span id="apache-beam-testing-benchmarks-nexmark-nexmark-launcher-module"></span><h1>apache_beam.testing.benchmarks.nexmark.nexmark_launcher module<a class="headerlink" href="#module-apache_beam.testing.benchmarks.nexmark.nexmark_launcher" title="Link to this heading"></a></h1> |
| <p>Nexmark launcher.</p> |
| <p>The Nexmark suite is a series of queries (streaming pipelines) performed |
| on a simulation of auction events. The launcher orchestrates the generation |
| and parsing of streaming events and the running of queries.</p> |
| <dl class="simple"> |
| <dt>Model</dt><dd><ul class="simple"> |
| <li><p>Person: Author of an auction or a bid.</p></li> |
| <li><p>Auction: Item under auction.</p></li> |
| <li><p>Bid: A bid for an item under auction.</p></li> |
| </ul> |
| </dd> |
| <dt>Events</dt><dd><ul class="simple"> |
| <li><p>Create Person</p></li> |
| <li><p>Create Auction</p></li> |
| <li><p>Create Bid</p></li> |
| </ul> |
| </dd> |
| <dt>Queries</dt><dd><ul class="simple"> |
| <li><p>Query0: Pass through (send and receive auction events).</p></li> |
| </ul> |
| </dd> |
| <dt>Usage</dt><dd><ul class="simple"> |
| <li><dl class="simple"> |
| <dt>DirectRunner</dt><dd><p>python nexmark_launcher.py –query/q <query number> –project <project id> –loglevel=DEBUG (optional) –wait_until_finish_duration <time_in_ms> –streaming</p> |
| </dd> |
| </dl> |
| </li> |
| <li><dl class="simple"> |
| <dt>DataflowRunner</dt><dd><p>python nexmark_launcher.py –query/q <query number> –project <project id> –region <GCE region> –loglevel=DEBUG (optional) –wait_until_finish_duration <time_in_ms> –streaming –sdk_location <apache_beam tar.gz> –staging_location=gs://… –temp_location=gs://</p> |
| </dd> |
| </dl> |
| </li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_launcher.</span></span><span class="sig-name descname"><span class="pre">NexmarkLauncher</span></span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher" 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 attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.DONE_DELAY"> |
| <span class="sig-name descname"><span class="pre">DONE_DELAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">300</span></em><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.DONE_DELAY" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.PERF_DELAY"> |
| <span class="sig-name descname"><span class="pre">PERF_DELAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></em><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.PERF_DELAY" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.TERMINATE_DELAY"> |
| <span class="sig-name descname"><span class="pre">TERMINATE_DELAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3600</span></em><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.TERMINATE_DELAY" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.WARNING_DELAY"> |
| <span class="sig-name descname"><span class="pre">WARNING_DELAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">600</span></em><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.WARNING_DELAY" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.parse_args"> |
| <span class="sig-name descname"><span class="pre">parse_args</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.parse_args"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.parse_args" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.generate_events"> |
| <span class="sig-name descname"><span class="pre">generate_events</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.generate_events"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.generate_events" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.read_from_file"> |
| <span class="sig-name descname"><span class="pre">read_from_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.read_from_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.read_from_file" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.read_from_pubsub"> |
| <span class="sig-name descname"><span class="pre">read_from_pubsub</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.read_from_pubsub"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.read_from_pubsub" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.run_query"> |
| <span class="sig-name descname"><span class="pre">run_query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query_num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query_args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipeline_options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query_errors</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.run_query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.run_query" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.monitor"> |
| <span class="sig-name descname"><span class="pre">monitor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">job</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_monitor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result_monitor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.monitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.monitor" title="Link to this definition"></a></dt> |
| <dd><p>keep monitoring the performance and progress of running job and cancel |
| the job if the job is stuck or seems to have finished running</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>the final performance if it is measured</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.log_performance"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_performance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">perf</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.benchmarks.nexmark.nexmark_perf.html#apache_beam.testing.benchmarks.nexmark.nexmark_perf.NexmarkPerf" title="apache_beam.testing.benchmarks.nexmark.nexmark_perf.NexmarkPerf"><span class="pre">NexmarkPerf</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/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/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.log_performance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.log_performance" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.publish_performance_influxdb"> |
| <span class="sig-name descname"><span class="pre">publish_performance_influxdb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query_num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">perf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.publish_performance_influxdb"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.publish_performance_influxdb" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.get_performance"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_performance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_monitor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result_monitor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.get_performance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.get_performance" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.cleanup"> |
| <span class="sig-name descname"><span class="pre">cleanup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.cleanup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.cleanup" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.run"> |
| <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_launcher.html#NexmarkLauncher.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_launcher.NexmarkLauncher.run" 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.benchmarks.nexmark.monitor.html" class="btn btn-neutral float-left" title="apache_beam.testing.benchmarks.nexmark.monitor module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.testing.benchmarks.nexmark.nexmark_perf.html" class="btn btn-neutral float-right" title="apache_beam.testing.benchmarks.nexmark.nexmark_perf 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> |
