| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 --> |
| <title>PortableMetrics (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="PortableMetrics (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/runners/portability/ExternalWorkerService.html" title="class in org.apache.beam.runners.portability"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/portability/PortableRunner.html" title="class in org.apache.beam.runners.portability"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/portability/PortableMetrics.html" target="_top">Frames</a></li> |
| <li><a href="PortableMetrics.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.runners.portability</div> |
| <h2 title="Class PortableMetrics" class="title">Class PortableMetrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">org.apache.beam.sdk.metrics.MetricResults</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.portability.PortableMetrics</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PortableMetrics</span> |
| extends <a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="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 <a href="../../../../../org/apache/beam/runners/portability/PortableMetrics.html" title="class in org.apache.beam.runners.portability">PortableMetrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/portability/PortableMetrics.html#of-org.apache.beam.model.jobmanagement.v1.JobApi.MetricResults-">of</a></span>(org.apache.beam.model.jobmanagement.v1.JobApi.MetricResults jobMetrics)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/metrics/MetricQueryResults.html" title="class in org.apache.beam.sdk.metrics">MetricQueryResults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/portability/PortableMetrics.html#queryMetrics-org.apache.beam.sdk.metrics.MetricsFilter-">queryMetrics</a></span>(<a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics">MetricsFilter</a> filter)</code> |
| <div class="block">Query for all metric values that match a given filter.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.metrics.MetricResults"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.metrics.<a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></h3> |
| <code><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html#allMetrics--">allMetrics</a>, <a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html#toString--">toString</a></code></li> |
| </ul> |
| <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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="of-org.apache.beam.model.jobmanagement.v1.JobApi.MetricResults-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/runners/portability/PortableMetrics.html" title="class in org.apache.beam.runners.portability">PortableMetrics</a> of(org.apache.beam.model.jobmanagement.v1.JobApi.MetricResults jobMetrics)</pre> |
| </li> |
| </ul> |
| <a name="queryMetrics-org.apache.beam.sdk.metrics.MetricsFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>queryMetrics</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/metrics/MetricQueryResults.html" title="class in org.apache.beam.sdk.metrics">MetricQueryResults</a> queryMetrics(<a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics">MetricsFilter</a> filter)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html#queryMetrics-org.apache.beam.sdk.metrics.MetricsFilter-">MetricResults</a></code></span></div> |
| <div class="block">Query for all metric values that match a given filter. |
| |
| <p>The <code>filter</code> may filter based on the namespace and/or name of the metric, as well as |
| the step that reported the metric. |
| |
| <p>For each type of metric, the result contains an iterable of all metrics of that type that |
| matched the filter. Each <a href="../../../../../org/apache/beam/sdk/metrics/MetricResult.html" title="class in org.apache.beam.sdk.metrics"><code>MetricResult</code></a> includes the name of the metric, the step in |
| which it was reported and the <a href="../../../../../org/apache/beam/sdk/metrics/MetricResult.html#getCommitted--"><code>MetricResult.getCommitted()</code></a> and <a href="../../../../../org/apache/beam/sdk/metrics/MetricResult.html#getAttempted--"><code>MetricResult.getAttempted()</code></a> values. |
| |
| <p>Note that runners differ in their support for committed and attempted values. |
| |
| <p>Example: Querying the metrics reported from the <code>SomeDoFn</code> example in <a href="../../../../../org/apache/beam/sdk/metrics/Metrics.html" title="class in org.apache.beam.sdk.metrics"><code>Metrics</code></a> |
| could be done as follows: |
| |
| <pre><code> |
| Pipeline p = ...; |
| p.apply("create1", Create.of("hello")).apply("myStepName1", ParDo.of(new SomeDoFn())); |
| p.apply("create2", Create.of("world")).apply("myStepName2", ParDo.of(new SomeDoFn())); |
| PipelineResult result = p.run(); |
| MetricResults metrics = result.metrics(); |
| MetricQueryResults metricResults = metrics.queryMetrics(new MetricsFilter.Builder() |
| .addNameFilter("my-counter") |
| .addStepFilter("myStepName1").addStepFilter("myStepName2") |
| .build()); |
| Iterable<MetricResult<Long>> counters = metricResults.getCounters(); |
| // counters should contain the value of my-counter reported from each of the ParDo |
| // applications. |
| </code></pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html#queryMetrics-org.apache.beam.sdk.metrics.MetricsFilter-">queryMetrics</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></code></dd> |
| </dl> |
| </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/runners/portability/ExternalWorkerService.html" title="class in org.apache.beam.runners.portability"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/portability/PortableRunner.html" title="class in org.apache.beam.runners.portability"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/portability/PortableMetrics.html" target="_top">Frames</a></li> |
| <li><a href="PortableMetrics.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
