| <!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_161-google-v7) on Thu Oct 18 16:14:33 PDT 2018 --> |
| <title>MetricsEnvironment (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="MetricsEnvironment (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/MetricsEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="MetricsEnvironment.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.sdk.metrics</div> |
| <h2 title="Class MetricsEnvironment" class="title">Class MetricsEnvironment</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.metrics.MetricsEnvironment</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#METRICS">METRICS</a>) |
| <a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public class <span class="typeNameLabel">MetricsEnvironment</span> |
| extends java.lang.Object</pre> |
| <div class="block">Manages and provides the metrics container associated with each thread. |
| |
| <p>Users should not interact directly with this class. Instead, use <a href="../../../../../org/apache/beam/sdk/metrics/Metrics.html" title="class in org.apache.beam.sdk.metrics"><code>Metrics</code></a> and the |
| returned objects to create and modify metrics. |
| |
| <p>The runner should create a <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for each context in which metrics are |
| reported (by step and name) and call <a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#setCurrentContainer-org.apache.beam.sdk.metrics.MetricsContainer-"><code>setCurrentContainer(org.apache.beam.sdk.metrics.MetricsContainer)</code></a> before invoking any code that |
| may update metrics within that step. It should call <a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#setCurrentContainer-org.apache.beam.sdk.metrics.MetricsContainer-"><code>setCurrentContainer(org.apache.beam.sdk.metrics.MetricsContainer)</code></a> again to restore |
| the previous container. |
| |
| <p>Alternatively, the runner can use <a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#scopedMetricsContainer-org.apache.beam.sdk.metrics.MetricsContainer-"><code>scopedMetricsContainer(MetricsContainer)</code></a> to set the |
| container for the current thread and get a <code>Closeable</code> that will restore the previous |
| container when closed.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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/sdk/metrics/MetricsEnvironment.html#MetricsEnvironment--">MetricsEnvironment</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="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/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#getCurrentContainer--">getCurrentContainer</a></span>()</code> |
| <div class="block">Return the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#isMetricsSupported--">isMetricsSupported</a></span>()</code> |
| <div class="block">Indicates whether metrics reporting is supported.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.io.Closeable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#scopedMetricsContainer-org.apache.beam.sdk.metrics.MetricsContainer-">scopedMetricsContainer</a></span>(<a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> container)</code> |
| <div class="block">Set the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#setCurrentContainer-org.apache.beam.sdk.metrics.MetricsContainer-">setCurrentContainer</a></span>(<a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> container)</code> |
| <div class="block">Set the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html#setMetricsSupported-boolean-">setMetricsSupported</a></span>(boolean supported)</code> |
| <div class="block">Called by the run to indicate whether metrics reporting is supported.</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MetricsEnvironment--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MetricsEnvironment</h4> |
| <pre>public MetricsEnvironment()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setCurrentContainer-org.apache.beam.sdk.metrics.MetricsContainer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentContainer</h4> |
| <pre>@Nullable |
| public static <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> setCurrentContainer(@Nullable |
| <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> container)</pre> |
| <div class="block">Set the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The previous container for the current thread.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMetricsSupported-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMetricsSupported</h4> |
| <pre>public static void setMetricsSupported(boolean supported)</pre> |
| <div class="block">Called by the run to indicate whether metrics reporting is supported.</div> |
| </li> |
| </ul> |
| <a name="isMetricsSupported--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetricsSupported</h4> |
| <pre>public static boolean isMetricsSupported()</pre> |
| <div class="block">Indicates whether metrics reporting is supported.</div> |
| </li> |
| </ul> |
| <a name="scopedMetricsContainer-org.apache.beam.sdk.metrics.MetricsContainer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scopedMetricsContainer</h4> |
| <pre>public static java.io.Closeable scopedMetricsContainer(<a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> container)</pre> |
| <div class="block">Set the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>Closeable</code> that will reset the current container to the previous <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> when closed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentContainer--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCurrentContainer</h4> |
| <pre>@Nullable |
| public static <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a> getCurrentContainer()</pre> |
| <div class="block">Return the <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for the current thread. |
| |
| <p>May return null if metrics are not supported by the current runner or if the current thread |
| is not a work-execution thread. The first time this happens in a given thread it will log a |
| diagnostic message.</div> |
| </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/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/MetricsEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="MetricsEnvironment.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |