| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- GitHub action javadoc-cleanup --> |
| <link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/it/gcp/LoadTestBase.html"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- End javadoc-cleanup block --> |
| <!-- Generated by javadoc --> |
| <title>LoadTestBase (Apache Beam 2.53.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="LoadTestBase (Apache Beam 2.53.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":6,"i13":10,"i14":9,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/it/gcp/IOLoadTestBase.PipelineMetricsType.html" title="enum in org.apache.beam.it.gcp"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/it/gcp/LoadTestBase.html" target="_top">Frames</a></li> |
| <li><a href="LoadTestBase.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.it.gcp</div> |
| <h2 title="Class LoadTestBase" class="title">Class LoadTestBase</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.it.gcp.LoadTestBase</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/beam/it/gcp/IOLoadTestBase.html" title="class in org.apache.beam.it.gcp">IOLoadTestBase</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">LoadTestBase</span> |
| extends java.lang.Object</pre> |
| <div class="block">Base class for performance tests. It provides helper methods for common operations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp">LoadTestBase.MetricsConfiguration</a></span></code> |
| <div class="block">Utils for the metrics.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static com.google.auth.Credentials</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#CREDENTIALS">CREDENTIALS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static com.google.api.gax.core.CredentialsProvider</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#CREDENTIALS_PROVIDER">CREDENTIALS_PROVIDER</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/beam/it/gcp/monitoring/MonitoringClient.html" title="class in org.apache.beam.it.gcp.monitoring">MonitoringClient</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#monitoringClient">monitoringClient</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.beam.it.common.PipelineLauncher</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#pipelineLauncher">pipelineLauncher</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.beam.it.common.PipelineOperator</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#pipelineOperator">pipelineOperator</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#project">project</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#region">region</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#testName">testName</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/junit/junit/4.13.1/org/junit/rules/TestRule.html?is-external=true" title="class or interface in org.junit.rules">TestRule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#watcher">watcher</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#LoadTestBase--">LoadTestBase</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.lang.Double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#calculateAverage-java.util.List-">calculateAverage</a></span>(java.util.List<java.lang.Double> values)</code> |
| <div class="block">Calculate the average from a series.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.beam.it.common.PipelineOperator.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#createConfig-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.time.Duration-">createConfig</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo info, |
| java.time.Duration timeout)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#exportMetricsToBigQuery-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.util.Map-">exportMetricsToBigQuery</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| java.util.Map<java.lang.String,java.lang.Double> metrics)</code> |
| <div class="block">Exports the metrics of given dataflow job to BigQuery.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getCpuUtilizationMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-">getCpuUtilizationMetrics</a></span>(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</code> |
| <div class="block">Computes CPU Utilization metrics of the given job.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getDataFreshnessMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-">getDataFreshnessMetrics</a></span>(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</code> |
| <div class="block">Computes Data freshness metrics of the given job.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-">getMetrics</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo)</code> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-org.apache.beam.it.gcp.LoadTestBase.MetricsConfiguration-">getMetrics</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| <a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp">LoadTestBase.MetricsConfiguration</a> config)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.lang.String-">getMetrics</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| java.lang.String inputPcollection)</code> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.lang.String-java.lang.String-">getMetrics</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| java.lang.String inputPcollection, |
| java.lang.String outputPcollection)</code> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getSystemLatencyMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-">getSystemLatencyMetrics</a></span>(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</code> |
| <div class="block">Computes System latency metrics of the given job.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getThroughputMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-org.apache.beam.it.gcp.LoadTestBase.MetricsConfiguration-com.google.monitoring.v3.TimeInterval-">getThroughputMetrics</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo jobInfo, |
| <a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp">LoadTestBase.MetricsConfiguration</a> config, |
| com.google.monitoring.v3.TimeInterval timeInterval)</code> |
| <div class="block">Computes throughput metrics of the given pcollection in dataflow job.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected com.google.monitoring.v3.TimeInterval</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#getWorkerTimeInterval-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-">getWorkerTimeInterval</a></span>(org.apache.beam.it.common.PipelineLauncher.LaunchInfo info)</code> |
| <div class="block">Gets the time interval when workers were active to be used by monitoring client.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract org.apache.beam.it.common.PipelineLauncher</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#launcher--">launcher</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#setUp--">setUp</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#setUpClass--">setUpClass</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#tearDownLoadTestBase--">tearDownLoadTestBase</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.html#waitForNumMessages-java.lang.String-java.lang.String-java.lang.Long-">waitForNumMessages</a></span>(java.lang.String jobId, |
| java.lang.String pcollection, |
| java.lang.Long expectedElements)</code> |
| <div class="block">Checks if the input PCollection has the expected number of messages.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CREDENTIALS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CREDENTIALS</h4> |
| <pre>protected static final com.google.auth.Credentials CREDENTIALS</pre> |
| </li> |
| </ul> |
| <a name="CREDENTIALS_PROVIDER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CREDENTIALS_PROVIDER</h4> |
| <pre>protected static final com.google.api.gax.core.CredentialsProvider CREDENTIALS_PROVIDER</pre> |
| </li> |
| </ul> |
| <a name="project"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre>protected static java.lang.String project</pre> |
| </li> |
| </ul> |
| <a name="region"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>region</h4> |
| <pre>protected static java.lang.String region</pre> |
| </li> |
| </ul> |
| <a name="monitoringClient"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>monitoringClient</h4> |
| <pre>protected <a href="../../../../../org/apache/beam/it/gcp/monitoring/MonitoringClient.html" title="class in org.apache.beam.it.gcp.monitoring">MonitoringClient</a> monitoringClient</pre> |
| </li> |
| </ul> |
| <a name="pipelineLauncher"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pipelineLauncher</h4> |
| <pre>protected org.apache.beam.it.common.PipelineLauncher pipelineLauncher</pre> |
| </li> |
| </ul> |
| <a name="pipelineOperator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pipelineOperator</h4> |
| <pre>protected org.apache.beam.it.common.PipelineOperator pipelineOperator</pre> |
| </li> |
| </ul> |
| <a name="testName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>testName</h4> |
| <pre>protected java.lang.String testName</pre> |
| </li> |
| </ul> |
| <a name="watcher"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>watcher</h4> |
| <pre>public <a href="https://static.javadoc.io/junit/junit/4.13.1/org/junit/rules/TestRule.html?is-external=true" title="class or interface in org.junit.rules">TestRule</a> watcher</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LoadTestBase--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LoadTestBase</h4> |
| <pre>public LoadTestBase()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setUpClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpClass</h4> |
| <pre>public static void setUpClass()</pre> |
| </li> |
| </ul> |
| <a name="setUp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUp</h4> |
| <pre>public void setUp() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tearDownLoadTestBase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tearDownLoadTestBase</h4> |
| <pre>public void tearDownLoadTestBase() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="launcher--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>launcher</h4> |
| <pre>public abstract org.apache.beam.it.common.PipelineLauncher launcher()</pre> |
| </li> |
| </ul> |
| <a name="exportMetricsToBigQuery-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exportMetricsToBigQuery</h4> |
| <pre>protected void exportMetricsToBigQuery(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| java.util.Map<java.lang.String,java.lang.Double> metrics)</pre> |
| <div class="block">Exports the metrics of given dataflow job to BigQuery.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>launchInfo</code> - Job info of the job</dd> |
| <dd><code>metrics</code> - metrics to export</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForNumMessages-java.lang.String-java.lang.String-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForNumMessages</h4> |
| <pre>protected boolean waitForNumMessages(java.lang.String jobId, |
| java.lang.String pcollection, |
| java.lang.Long expectedElements)</pre> |
| <div class="block">Checks if the input PCollection has the expected number of messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - JobId of the job</dd> |
| <dd><code>pcollection</code> - the input pcollection name</dd> |
| <dd><code>expectedElements</code> - expected number of messages</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the input pcollection has the expected number of messages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getMetrics(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| <a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| java.lang.String inputPcollection, |
| <a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| java.lang.String outputPcollection) |
| throws java.lang.InterruptedException, |
| java.io.IOException, |
| java.text.ParseException</pre> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>launchInfo</code> - Job info of the job</dd> |
| <dd><code>inputPcollection</code> - input pcollection of the dataflow job to query additional metrics. If |
| not provided, the metrics will not be calculated.</dd> |
| <dd><code>outputPcollection</code> - output pcollection of the dataflow job to query additional metrics. If |
| not provided, the metrics will not be calculated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>metrics</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if there is an issue sending the request</dd> |
| <dd><code>java.text.ParseException</code> - if timestamp is inaccurate</dd> |
| <dd><code>java.lang.InterruptedException</code> - thrown if thread is interrupted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getMetrics(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| java.lang.String inputPcollection) |
| throws java.text.ParseException, |
| java.lang.InterruptedException, |
| java.io.IOException</pre> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>launchInfo</code> - Job info of the job</dd> |
| <dd><code>inputPcollection</code> - input pcollection of the dataflow job to query additional metrics. If |
| not provided, the metrics will not be calculated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>metrics</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if there is an issue sending the request</dd> |
| <dd><code>java.text.ParseException</code> - if timestamp is inaccurate</dd> |
| <dd><code>java.lang.InterruptedException</code> - thrown if thread is interrupted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getMetrics(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo) |
| throws java.text.ParseException, |
| java.lang.InterruptedException, |
| java.io.IOException</pre> |
| <div class="block">Computes the metrics of the given job using dataflow and monitoring clients.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>launchInfo</code> - Job info of the job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>metrics</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if there is an issue sending the request</dd> |
| <dd><code>java.text.ParseException</code> - if timestamp is inaccurate</dd> |
| <dd><code>java.lang.InterruptedException</code> - thrown if thread is interrupted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-org.apache.beam.it.gcp.LoadTestBase.MetricsConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getMetrics(org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, |
| <a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp">LoadTestBase.MetricsConfiguration</a> config) |
| throws java.io.IOException, |
| java.lang.InterruptedException, |
| java.text.ParseException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| <dd><code>java.lang.InterruptedException</code></dd> |
| <dd><code>java.text.ParseException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCpuUtilizationMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCpuUtilizationMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getCpuUtilizationMetrics(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</pre> |
| <div class="block">Computes CPU Utilization metrics of the given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - dataflow job id</dd> |
| <dd><code>timeInterval</code> - interval for the monitoring query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>CPU Utilization metrics of the job</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getThroughputMetrics-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-org.apache.beam.it.gcp.LoadTestBase.MetricsConfiguration-com.google.monitoring.v3.TimeInterval-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThroughputMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getThroughputMetrics(org.apache.beam.it.common.PipelineLauncher.LaunchInfo jobInfo, |
| <a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp">LoadTestBase.MetricsConfiguration</a> config, |
| com.google.monitoring.v3.TimeInterval timeInterval)</pre> |
| <div class="block">Computes throughput metrics of the given pcollection in dataflow job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobInfo</code> - dataflow job LaunchInfo</dd> |
| <dd><code>config</code> - the </dd> |
| <dd><code>timeInterval</code> - interval for the monitoring query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>throughput metrics of the pcollection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataFreshnessMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataFreshnessMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getDataFreshnessMetrics(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</pre> |
| <div class="block">Computes Data freshness metrics of the given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - dataflow job id</dd> |
| <dd><code>timeInterval</code> - interval for the monitoring query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Data freshness metrics of the job</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSystemLatencyMetrics-java.lang.String-com.google.monitoring.v3.TimeInterval-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemLatencyMetrics</h4> |
| <pre>protected java.util.Map<java.lang.String,java.lang.Double> getSystemLatencyMetrics(java.lang.String jobId, |
| com.google.monitoring.v3.TimeInterval timeInterval)</pre> |
| <div class="block">Computes System latency metrics of the given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - dataflow job id</dd> |
| <dd><code>timeInterval</code> - interval for the monitoring query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>System latency metrics of the job</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkerTimeInterval-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkerTimeInterval</h4> |
| <pre>protected com.google.monitoring.v3.TimeInterval getWorkerTimeInterval(org.apache.beam.it.common.PipelineLauncher.LaunchInfo info) |
| throws java.text.ParseException</pre> |
| <div class="block">Gets the time interval when workers were active to be used by monitoring client.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.text.ParseException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="calculateAverage-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calculateAverage</h4> |
| <pre>public static java.lang.Double calculateAverage(java.util.List<java.lang.Double> values)</pre> |
| <div class="block">Calculate the average from a series.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the input series.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the averaged result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createConfig-org.apache.beam.it.common.PipelineLauncher.LaunchInfo-java.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createConfig</h4> |
| <pre>public static org.apache.beam.it.common.PipelineOperator.Config createConfig(org.apache.beam.it.common.PipelineLauncher.LaunchInfo info, |
| java.time.Duration timeout)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/it/gcp/IOLoadTestBase.PipelineMetricsType.html" title="enum in org.apache.beam.it.gcp"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/it/gcp/LoadTestBase.MetricsConfiguration.html" title="class in org.apache.beam.it.gcp"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/it/gcp/LoadTestBase.html" target="_top">Frames</a></li> |
| <li><a href="LoadTestBase.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
