ChangeStreamMetrics (Apache Beam 2.54.0)

java.lang.Object
- org.apache.beam.sdk.io.gcp.spanner.changestreams.ChangeStreamMetrics

All Implemented Interfaces:

java.io.Serializable
```
public class ChangeStreamMetrics
extends java.lang.Object
implements java.io.Serializable
```
Class to aggregate metrics related functionality.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Counter`	`ACTIVE_PARTITION_READ_COUNT` Counter for the active partition reads during the execution of the Connector.
`static Counter`	`DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT` Counter for record latencies [0, 1000) ms during the execution of the Connector.
`static Counter`	`DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT` Counter for record latencies [1000, 3000) ms during the execution of the Connector.
`static Counter`	`DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT` Counter for record latencies equal or above 3000ms during the execution of the Connector.
`static Counter`	`DATA_RECORD_COUNT` Counter for the total number of data records identified during the execution of the Connector.
`static Counter`	`HEARTBEAT_RECORD_COUNT` Counter for the total number of heartbeat records identified during the execution of the Connector.
`static Distribution`	`PARTITION_CREATED_TO_SCHEDULED_MS` Time in milliseconds that a partition took to transition from `PartitionMetadata.State.CREATED` to `PartitionMetadata.State.SCHEDULED`.
`static Counter`	`PARTITION_RECORD_COUNT` Counter for the total number of partitions identified during the execution of the Connector.
`static Counter`	`PARTITION_RECORD_MERGE_COUNT` Counter for the total number of partition merges identified during the execution of the Connector.
`static Counter`	`PARTITION_RECORD_SPLIT_COUNT` Counter for the total number of partition splits / moves identified during the execution of the Connector.
`static Distribution`	`PARTITION_SCHEDULED_TO_RUNNING_MS` Time in milliseconds that a partition took to transition from `PartitionMetadata.State.SCHEDULED` to `PartitionMetadata.State.RUNNING`.
`static Counter`	`QUERY_COUNT` Counter for the total number of queries issued during the execution of the Connector.

Constructor Summary

Constructors
Constructor and Description
`ChangeStreamMetrics()` Constructs a ChangeStreamMetrics instance with the following metrics enabled by default.
`ChangeStreamMetrics(java.util.Set<MetricName> enabledMetrics)` Constructs a ChangeStreamMetrics instance with the given metrics enabled.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decActivePartitionReadCounter()` Decrements the `ACTIVE_PARTITION_READ_COUNT` by 1 if the metric is enabled.
`void`	`incActivePartitionReadCounter()` Increments the `ACTIVE_PARTITION_READ_COUNT` by 1 if the metric is enabled.
`void`	`incDataRecordCounter()` Increments the `DATA_RECORD_COUNT` by 1 if the metric is enabled.
`void`	`incHeartbeatRecordCount()` Increments the `HEARTBEAT_RECORD_COUNT` by 1 if the metric is enabled.
`void`	`incPartitionRecordCount()` Increments the `PARTITION_RECORD_COUNT` by 1 if the metric is enabled.
`void`	`incPartitionRecordMergeCount()` Increments the `PARTITION_RECORD_MERGE_COUNT` by 1 if the metric is enabled.
`void`	`incPartitionRecordSplitCount()` Increments the `PARTITION_RECORD_SPLIT_COUNT` by 1 if the metric is enabled.
`void`	`incQueryCounter()` Increments the `QUERY_COUNT` by 1 if the metric is enabled.
`void`	`updateDataRecordCommittedToEmitted(Duration duration)`
`void`	`updatePartitionCreatedToScheduled(Duration duration)` Adds measurement of an instance for the `PARTITION_CREATED_TO_SCHEDULED_MS` if the metric is enabled.
`void`	`updatePartitionScheduledToRunning(Duration duration)` Adds measurement of an instance for the `PARTITION_SCHEDULED_TO_RUNNING_MS` if the metric is enabled.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARTITION_RECORD_COUNT
```
public static final Counter PARTITION_RECORD_COUNT
```
    Counter for the total number of partitions identified during the execution of the Connector.
  - PARTITION_RECORD_SPLIT_COUNT
```
public static final Counter PARTITION_RECORD_SPLIT_COUNT
```
    Counter for the total number of partition splits / moves identified during the execution of the Connector.
  - PARTITION_RECORD_MERGE_COUNT
```
public static final Counter PARTITION_RECORD_MERGE_COUNT
```
    Counter for the total number of partition merges identified during the execution of the Connector.
  - PARTITION_CREATED_TO_SCHEDULED_MS
```
public static final Distribution PARTITION_CREATED_TO_SCHEDULED_MS
```
    Time in milliseconds that a partition took to transition from PartitionMetadata.State.CREATED to PartitionMetadata.State.SCHEDULED.
  - PARTITION_SCHEDULED_TO_RUNNING_MS
```
public static final Distribution PARTITION_SCHEDULED_TO_RUNNING_MS
```
    Time in milliseconds that a partition took to transition from PartitionMetadata.State.SCHEDULED to PartitionMetadata.State.RUNNING.
  - ACTIVE_PARTITION_READ_COUNT
```
public static final Counter ACTIVE_PARTITION_READ_COUNT
```
    Counter for the active partition reads during the execution of the Connector.
  - DATA_RECORD_COUNT
```
public static final Counter DATA_RECORD_COUNT
```
    Counter for the total number of data records identified during the execution of the Connector.
  - QUERY_COUNT
```
public static final Counter QUERY_COUNT
```
    Counter for the total number of queries issued during the execution of the Connector.
  - DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT
```
public static final Counter DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT
```
    Counter for record latencies [0, 1000) ms during the execution of the Connector.
  - DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT
```
public static final Counter DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT
```
    Counter for record latencies [1000, 3000) ms during the execution of the Connector.
  - DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT
```
public static final Counter DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT
```
    Counter for record latencies equal or above 3000ms during the execution of the Connector.
  - HEARTBEAT_RECORD_COUNT
```
public static final Counter HEARTBEAT_RECORD_COUNT
```
    Counter for the total number of heartbeat records identified during the execution of the Connector.
- Constructor Detail
  - ChangeStreamMetrics
```
public ChangeStreamMetrics()
```
    Constructs a ChangeStreamMetrics instance with the following metrics enabled by default.
  - ChangeStreamMetrics
```
public ChangeStreamMetrics(java.util.Set<MetricName> enabledMetrics)
```
    Constructs a ChangeStreamMetrics instance with the given metrics enabled.
    
    Parameters:
    
    enabledMetrics - metrics to be enabled during the Connector execution
- Method Detail
  - incPartitionRecordCount
```
public void incPartitionRecordCount()
```
    Increments the PARTITION_RECORD_COUNT by 1 if the metric is enabled.
  - incPartitionRecordSplitCount
```
public void incPartitionRecordSplitCount()
```
    Increments the PARTITION_RECORD_SPLIT_COUNT by 1 if the metric is enabled.
  - incPartitionRecordMergeCount
```
public void incPartitionRecordMergeCount()
```
    Increments the PARTITION_RECORD_MERGE_COUNT by 1 if the metric is enabled.
  - updatePartitionCreatedToScheduled
```
public void updatePartitionCreatedToScheduled(Duration duration)
```
    Adds measurement of an instance for the PARTITION_CREATED_TO_SCHEDULED_MS if the metric is enabled.
  - updatePartitionScheduledToRunning
```
public void updatePartitionScheduledToRunning(Duration duration)
```
    Adds measurement of an instance for the PARTITION_SCHEDULED_TO_RUNNING_MS if the metric is enabled.
  - incActivePartitionReadCounter
```
public void incActivePartitionReadCounter()
```
    Increments the ACTIVE_PARTITION_READ_COUNT by 1 if the metric is enabled.
  - decActivePartitionReadCounter
```
public void decActivePartitionReadCounter()
```
    Decrements the ACTIVE_PARTITION_READ_COUNT by 1 if the metric is enabled.
  - incDataRecordCounter
```
public void incDataRecordCounter()
```
    Increments the DATA_RECORD_COUNT by 1 if the metric is enabled.
  - incQueryCounter
```
public void incQueryCounter()
```
    Increments the QUERY_COUNT by 1 if the metric is enabled.
  - incHeartbeatRecordCount
```
public void incHeartbeatRecordCount()
```
    Increments the HEARTBEAT_RECORD_COUNT by 1 if the metric is enabled.
  - updateDataRecordCommittedToEmitted
```
public void updateDataRecordCommittedToEmitted(Duration duration)
```

Class ChangeStreamMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARTITION_RECORD_COUNT

PARTITION_RECORD_SPLIT_COUNT

PARTITION_RECORD_MERGE_COUNT

PARTITION_CREATED_TO_SCHEDULED_MS

PARTITION_SCHEDULED_TO_RUNNING_MS

ACTIVE_PARTITION_READ_COUNT

DATA_RECORD_COUNT

QUERY_COUNT

DATA_RECORD_COMMITTED_TO_EMITTED_0MS_TO_1000MS_COUNT

DATA_RECORD_COMMITTED_TO_EMITTED_1000MS_TO_3000MS_COUNT

DATA_RECORD_COMMITTED_TO_EMITTED_3000MS_TO_INF_COUNT

HEARTBEAT_RECORD_COUNT

Constructor Detail

ChangeStreamMetrics

ChangeStreamMetrics

Method Detail

incPartitionRecordCount

incPartitionRecordSplitCount

incPartitionRecordMergeCount

updatePartitionCreatedToScheduled

updatePartitionScheduledToRunning

incActivePartitionReadCounter

decActivePartitionReadCounter

incDataRecordCounter

incQueryCounter

incHeartbeatRecordCount

updateDataRecordCommittedToEmitted