| <!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 --> |
| <title>ChangeStreamMetrics (Apache Beam 2.38.0-SNAPSHOT)</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="ChangeStreamMetrics (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All 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>Prev Class</li> |
| <li><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamsConstants.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html" target="_top">Frames</a></li> |
| <li><a href="ChangeStreamMetrics.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><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.sdk.io.gcp.spanner.changestreams</div> |
| <h2 title="Class ChangeStreamMetrics" class="title">Class ChangeStreamMetrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.spanner.changestreams.ChangeStreamMetrics</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ChangeStreamMetrics</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Class to aggregate metrics related functionality.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../serialized-form.html#org.apache.beam.sdk.io.gcp.spanner.changestreams.ChangeStreamMetrics">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ACTIVE_PARTITION_READ_COUNT">ACTIVE_PARTITION_READ_COUNT</a></span></code> |
| <div class="block">Counter for the active partition reads during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT">DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT</a></span></code> |
| <div class="block">Counter for record latencies [0, 1000) ms during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT">DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT</a></span></code> |
| <div class="block">Counter for record latencies [1000, 3000) ms during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT">DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT</a></span></code> |
| <div class="block">Counter for record latencies equal or above 3000ms during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COUNT">DATA_RECORD_COUNT</a></span></code> |
| <div class="block">Counter for the total number of data records identified during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#HEARTBEAT_RECORD_COUNT">HEARTBEAT_RECORD_COUNT</a></span></code> |
| <div class="block">Counter for the total number of heartbeat records identified during the execution of the |
| Connector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics">Distribution</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_CREATED_TO_SCHEDULED_MS">PARTITION_CREATED_TO_SCHEDULED_MS</a></span></code> |
| <div class="block">Time in milliseconds that a partition took to transition from <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#CREATED"><code>PartitionMetadata.State.CREATED</code></a> to <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#SCHEDULED"><code>PartitionMetadata.State.SCHEDULED</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_ID_ATTRIBUTE_LABEL">PARTITION_ID_ATTRIBUTE_LABEL</a></span></code> |
| <div class="block">Cloud Tracing label for Partition Tokens.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_COUNT">PARTITION_RECORD_COUNT</a></span></code> |
| <div class="block">Counter for the total number of partitions identified during the execution of the Connector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_MERGE_COUNT">PARTITION_RECORD_MERGE_COUNT</a></span></code> |
| <div class="block">Counter for the total number of partition merges identified during the execution of the |
| Connector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_SPLIT_COUNT">PARTITION_RECORD_SPLIT_COUNT</a></span></code> |
| <div class="block">Counter for the total number of partition splits / moves identified during the execution of the |
| Connector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics">Distribution</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_SCHEDULED_TO_RUNNING_MS">PARTITION_SCHEDULED_TO_RUNNING_MS</a></span></code> |
| <div class="block">Time in milliseconds that a partition took to transition from <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#SCHEDULED"><code>PartitionMetadata.State.SCHEDULED</code></a> to <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#RUNNING"><code>PartitionMetadata.State.RUNNING</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#QUERY_COUNT">QUERY_COUNT</a></span></code> |
| <div class="block">Counter for the total number of queries issued during the execution of the Connector.</div> |
| </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/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ChangeStreamMetrics--">ChangeStreamMetrics</a></span>()</code> |
| <div class="block">Constructs a ChangeStreamMetrics instance with the following metrics enabled by default: <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_COUNT"><code>PARTITION_RECORD_COUNT</code></a> and <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COUNT"><code>DATA_RECORD_COUNT</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ChangeStreamMetrics-java.util.Set-">ChangeStreamMetrics</a></span>(java.util.Set<<a href="../../../../../../../../org/apache/beam/sdk/metrics/MetricName.html" title="class in org.apache.beam.sdk.metrics">MetricName</a>> enabledMetrics)</code> |
| <div class="block">Constructs a ChangeStreamMetrics instance with the given metrics enabled.</div> |
| </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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#decActivePartitionReadCounter--">decActivePartitionReadCounter</a></span>()</code> |
| <div class="block">Decrements the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ACTIVE_PARTITION_READ_COUNT"><code>ACTIVE_PARTITION_READ_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incActivePartitionReadCounter--">incActivePartitionReadCounter</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ACTIVE_PARTITION_READ_COUNT"><code>ACTIVE_PARTITION_READ_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incDataRecordCounter--">incDataRecordCounter</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COUNT"><code>DATA_RECORD_COUNT</code></a> by 1 if the metric is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incHeartbeatRecordCount--">incHeartbeatRecordCount</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#HEARTBEAT_RECORD_COUNT"><code>HEARTBEAT_RECORD_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incPartitionRecordCount--">incPartitionRecordCount</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_COUNT"><code>PARTITION_RECORD_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incPartitionRecordMergeCount--">incPartitionRecordMergeCount</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_MERGE_COUNT"><code>PARTITION_RECORD_MERGE_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incPartitionRecordSplitCount--">incPartitionRecordSplitCount</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_SPLIT_COUNT"><code>PARTITION_RECORD_SPLIT_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#incQueryCounter--">incQueryCounter</a></span>()</code> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#QUERY_COUNT"><code>QUERY_COUNT</code></a> by 1 if the metric is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#updateDataRecordCommittedToEmitted-org.joda.time.Duration-">updateDataRecordCommittedToEmitted</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#updatePartitionCreatedToScheduled-org.joda.time.Duration-">updatePartitionCreatedToScheduled</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</code> |
| <div class="block">Adds measurement of an instance for the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_CREATED_TO_SCHEDULED_MS"><code>PARTITION_CREATED_TO_SCHEDULED_MS</code></a> if the metric is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#updatePartitionScheduledToRunning-org.joda.time.Duration-">updatePartitionScheduledToRunning</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</code> |
| <div class="block">Adds measurement of an instance for the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_SCHEDULED_TO_RUNNING_MS"><code>PARTITION_SCHEDULED_TO_RUNNING_MS</code></a> if the metric is enabled.</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="PARTITION_ID_ATTRIBUTE_LABEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_ID_ATTRIBUTE_LABEL</h4> |
| <pre>public static final java.lang.String PARTITION_ID_ATTRIBUTE_LABEL</pre> |
| <div class="block">Cloud Tracing label for Partition Tokens.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../constant-values.html#org.apache.beam.sdk.io.gcp.spanner.changestreams.ChangeStreamMetrics.PARTITION_ID_ATTRIBUTE_LABEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PARTITION_RECORD_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_RECORD_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> PARTITION_RECORD_COUNT</pre> |
| <div class="block">Counter for the total number of partitions identified during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="PARTITION_RECORD_SPLIT_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_RECORD_SPLIT_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> PARTITION_RECORD_SPLIT_COUNT</pre> |
| <div class="block">Counter for the total number of partition splits / moves identified during the execution of the |
| Connector.</div> |
| </li> |
| </ul> |
| <a name="PARTITION_RECORD_MERGE_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_RECORD_MERGE_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> PARTITION_RECORD_MERGE_COUNT</pre> |
| <div class="block">Counter for the total number of partition merges identified during the execution of the |
| Connector.</div> |
| </li> |
| </ul> |
| <a name="PARTITION_CREATED_TO_SCHEDULED_MS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_CREATED_TO_SCHEDULED_MS</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics">Distribution</a> PARTITION_CREATED_TO_SCHEDULED_MS</pre> |
| <div class="block">Time in milliseconds that a partition took to transition from <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#CREATED"><code>PartitionMetadata.State.CREATED</code></a> to <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#SCHEDULED"><code>PartitionMetadata.State.SCHEDULED</code></a>.</div> |
| </li> |
| </ul> |
| <a name="PARTITION_SCHEDULED_TO_RUNNING_MS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARTITION_SCHEDULED_TO_RUNNING_MS</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics">Distribution</a> PARTITION_SCHEDULED_TO_RUNNING_MS</pre> |
| <div class="block">Time in milliseconds that a partition took to transition from <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#SCHEDULED"><code>PartitionMetadata.State.SCHEDULED</code></a> to <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html#RUNNING"><code>PartitionMetadata.State.RUNNING</code></a>.</div> |
| </li> |
| </ul> |
| <a name="ACTIVE_PARTITION_READ_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTIVE_PARTITION_READ_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> ACTIVE_PARTITION_READ_COUNT</pre> |
| <div class="block">Counter for the active partition reads during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="DATA_RECORD_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_RECORD_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> DATA_RECORD_COUNT</pre> |
| <div class="block">Counter for the total number of data records identified during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="QUERY_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> QUERY_COUNT</pre> |
| <div class="block">Counter for the total number of queries issued during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT</pre> |
| <div class="block">Counter for record latencies [0, 1000) ms during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT</pre> |
| <div class="block">Counter for record latencies [1000, 3000) ms during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT</pre> |
| <div class="block">Counter for record latencies equal or above 3000ms during the execution of the Connector.</div> |
| </li> |
| </ul> |
| <a name="HEARTBEAT_RECORD_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HEARTBEAT_RECORD_COUNT</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> HEARTBEAT_RECORD_COUNT</pre> |
| <div class="block">Counter for the total number of heartbeat records identified during the execution of the |
| Connector.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ChangeStreamMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ChangeStreamMetrics</h4> |
| <pre>public ChangeStreamMetrics()</pre> |
| <div class="block">Constructs a ChangeStreamMetrics instance with the following metrics enabled by default: <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_COUNT"><code>PARTITION_RECORD_COUNT</code></a> and <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COUNT"><code>DATA_RECORD_COUNT</code></a>.</div> |
| </li> |
| </ul> |
| <a name="ChangeStreamMetrics-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ChangeStreamMetrics</h4> |
| <pre>public ChangeStreamMetrics(java.util.Set<<a href="../../../../../../../../org/apache/beam/sdk/metrics/MetricName.html" title="class in org.apache.beam.sdk.metrics">MetricName</a>> enabledMetrics)</pre> |
| <div class="block">Constructs a ChangeStreamMetrics instance with the given metrics enabled.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabledMetrics</code> - metrics to be enabled during the Connector execution</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="incPartitionRecordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incPartitionRecordCount</h4> |
| <pre>public void incPartitionRecordCount()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_COUNT"><code>PARTITION_RECORD_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="incPartitionRecordSplitCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incPartitionRecordSplitCount</h4> |
| <pre>public void incPartitionRecordSplitCount()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_SPLIT_COUNT"><code>PARTITION_RECORD_SPLIT_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="incPartitionRecordMergeCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incPartitionRecordMergeCount</h4> |
| <pre>public void incPartitionRecordMergeCount()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_RECORD_MERGE_COUNT"><code>PARTITION_RECORD_MERGE_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="updatePartitionCreatedToScheduled-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updatePartitionCreatedToScheduled</h4> |
| <pre>public void updatePartitionCreatedToScheduled(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</pre> |
| <div class="block">Adds measurement of an instance for the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_CREATED_TO_SCHEDULED_MS"><code>PARTITION_CREATED_TO_SCHEDULED_MS</code></a> if the metric is enabled.</div> |
| </li> |
| </ul> |
| <a name="updatePartitionScheduledToRunning-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updatePartitionScheduledToRunning</h4> |
| <pre>public void updatePartitionScheduledToRunning(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</pre> |
| <div class="block">Adds measurement of an instance for the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#PARTITION_SCHEDULED_TO_RUNNING_MS"><code>PARTITION_SCHEDULED_TO_RUNNING_MS</code></a> if the metric is enabled.</div> |
| </li> |
| </ul> |
| <a name="incActivePartitionReadCounter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incActivePartitionReadCounter</h4> |
| <pre>public void incActivePartitionReadCounter()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ACTIVE_PARTITION_READ_COUNT"><code>ACTIVE_PARTITION_READ_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="decActivePartitionReadCounter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decActivePartitionReadCounter</h4> |
| <pre>public void decActivePartitionReadCounter()</pre> |
| <div class="block">Decrements the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#ACTIVE_PARTITION_READ_COUNT"><code>ACTIVE_PARTITION_READ_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="incDataRecordCounter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incDataRecordCounter</h4> |
| <pre>public void incDataRecordCounter()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#DATA_RECORD_COUNT"><code>DATA_RECORD_COUNT</code></a> by 1 if the metric is enabled.</div> |
| </li> |
| </ul> |
| <a name="incQueryCounter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incQueryCounter</h4> |
| <pre>public void incQueryCounter()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#QUERY_COUNT"><code>QUERY_COUNT</code></a> by 1 if the metric is enabled.</div> |
| </li> |
| </ul> |
| <a name="incHeartbeatRecordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incHeartbeatRecordCount</h4> |
| <pre>public void incHeartbeatRecordCount()</pre> |
| <div class="block">Increments the <a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html#HEARTBEAT_RECORD_COUNT"><code>HEARTBEAT_RECORD_COUNT</code></a> by 1 if the metric is |
| enabled.</div> |
| </li> |
| </ul> |
| <a name="updateDataRecordCommittedToEmitted-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>updateDataRecordCommittedToEmitted</h4> |
| <pre>public void updateDataRecordCommittedToEmitted(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</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>Prev Class</li> |
| <li><a href="../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamsConstants.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/ChangeStreamMetrics.html" target="_top">Frames</a></li> |
| <li><a href="ChangeStreamMetrics.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><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> |
