| <!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:36 PST 2020 --> |
| <title>org.apache.beam.sdk.metrics (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="org.apache.beam.sdk.metrics (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/io/xml/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/options/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <p>@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.metrics</h1> |
| <div class="docSummary"> |
| <div class="block">Metrics allow exporting information about the execution of a pipeline.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></td> |
| <td class="colLast"> |
| <div class="block">A metric that reports a single long value and can be incremented or decremented.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics">Distribution</a></td> |
| <td class="colLast"> |
| <div class="block">A metric that reports information about the distribution of reported values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a></td> |
| <td class="colLast"> |
| <div class="block">A metric that reports the latest value out of reported values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/Metric.html" title="interface in org.apache.beam.sdk.metrics">Metric</a></td> |
| <td class="colLast"> |
| <div class="block">Marker interface for all user-facing metrics.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics">MetricsContainer</a></td> |
| <td class="colLast"> |
| <div class="block">Holds the metrics for a single step.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsOptions.html" title="interface in org.apache.beam.sdk.metrics">MetricsOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Extension of <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> that defines <a href="../../../../../org/apache/beam/sdk/metrics/MetricsSink.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsSink</code></a> specific options.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsSink.html" title="interface in org.apache.beam.sdk.metrics">MetricsSink</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for all metric sinks.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/DelegatingCounter.html" title="class in org.apache.beam.sdk.metrics">DelegatingCounter</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics"><code>Counter</code></a> that delegates to the instance for the current context.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/DistributionResult.html" title="class in org.apache.beam.sdk.metrics">DistributionResult</a></td> |
| <td class="colLast"> |
| <div class="block">The result of a <a href="../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics"><code>Distribution</code></a> metric.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/GaugeResult.html" title="class in org.apache.beam.sdk.metrics">GaugeResult</a></td> |
| <td class="colLast"> |
| <div class="block">The result of a <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics"><code>Gauge</code></a> metric.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/GaugeResult.EmptyGaugeResult.html" title="class in org.apache.beam.sdk.metrics">GaugeResult.EmptyGaugeResult</a></td> |
| <td class="colLast"> |
| <div class="block">Empty <a href="../../../../../org/apache/beam/sdk/metrics/GaugeResult.html" title="class in org.apache.beam.sdk.metrics"><code>GaugeResult</code></a>, representing no values reported.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricFiltering.html" title="class in org.apache.beam.sdk.metrics">MetricFiltering</a></td> |
| <td class="colLast"> |
| <div class="block">Implements matching for metrics filters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricKey.html" title="class in org.apache.beam.sdk.metrics">MetricKey</a></td> |
| <td class="colLast"> |
| <div class="block">Metrics are keyed by the step name they are associated with and the name of the metric.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricName.html" title="class in org.apache.beam.sdk.metrics">MetricName</a></td> |
| <td class="colLast"> |
| <div class="block">The name of a metric consists of a <a href="../../../../../org/apache/beam/sdk/metrics/MetricName.html#getNamespace--"><code>MetricName.getNamespace()</code></a> and a <a href="../../../../../org/apache/beam/sdk/metrics/MetricName.html#getName--"><code>MetricName.getName()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricNameFilter.html" title="class in org.apache.beam.sdk.metrics">MetricNameFilter</a></td> |
| <td class="colLast"> |
| <div class="block">The name of a metric.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricQueryResults.html" title="class in org.apache.beam.sdk.metrics">MetricQueryResults</a></td> |
| <td class="colLast"> |
| <div class="block">The results of a query for metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricResult.html" title="class in org.apache.beam.sdk.metrics">MetricResult</a><T></td> |
| <td class="colLast"> |
| <div class="block">The results of a single current metric.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></td> |
| <td class="colLast"> |
| <div class="block">Methods for interacting with the metrics of a pipeline that has been executed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/Metrics.html" title="class in org.apache.beam.sdk.metrics">Metrics</a></td> |
| <td class="colLast"> |
| <div class="block">The <code>Metrics</code> is a utility class for producing various kinds of metrics for reporting |
| properties of an executing pipeline.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsEnvironment.html" title="class in org.apache.beam.sdk.metrics">MetricsEnvironment</a></td> |
| <td class="colLast"> |
| <div class="block">Manages and provides the metrics container associated with each thread.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics">MetricsFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Simple POJO representing a filter for querying metrics.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.Builder.html" title="class in org.apache.beam.sdk.metrics">MetricsFilter.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">Builder for creating a <a href="../../../../../org/apache/beam/sdk/metrics/MetricsFilter.html" title="class in org.apache.beam.sdk.metrics"><code>MetricsFilter</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/MetricsOptions.NoOpMetricsSink.html" title="class in org.apache.beam.sdk.metrics">MetricsOptions.NoOpMetricsSink</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options"><code>DefaultValueFactory</code></a> that obtains the class of the <code>NoOpMetricsSink</code> if it |
| exists on the classpath, and throws an exception otherwise.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/SinkMetrics.html" title="class in org.apache.beam.sdk.metrics">SinkMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Standard Sink Metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html" title="class in org.apache.beam.sdk.metrics">SourceMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Standard <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> Metrics.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.metrics Description">Package org.apache.beam.sdk.metrics Description</h2> |
| <div class="block">Metrics allow exporting information about the execution of a pipeline. They are intended to be |
| used for monitoring and understanding the execution. |
| |
| <p>Metrics may also be queried from the <a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk"><code>PipelineResult</code></a> object. |
| |
| <p>Runners should look at <a href="../../../../../org/apache/beam/sdk/metrics/MetricsContainer.html" title="interface in org.apache.beam.sdk.metrics"><code>MetricsContainer</code></a> for details on how |
| to support metrics.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/io/xml/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/options/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
