ChangeStreamMetrics (Apache Beam 2.55.1)

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

All Implemented Interfaces:

java.io.Serializable
```
@Internal
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`	`CHANGE_STREAM_MUTATION_GC_COUNT` Counter for the total number of ChangeStreamMutations that are initiated by garbage collection (not user initiated) identified during the execution of the Connector.
`static Counter`	`CHANGE_STREAM_MUTATION_USER_COUNT` Counter for the total number of ChangeStreamMutations that are initiated by users (not garbage collection) identified during the execution of the Connector.
`static Counter`	`CLOSESTREAM_COUNT` Counter for the total number of heartbeats identified during the execution of the Connector.
`static Counter`	`HEARTBEAT_COUNT` Counter for the total number of heartbeats identified during the execution of the Connector.
`static Counter`	`LIST_PARTITIONS_COUNT` Counter for the total number of partitions identified during the execution of the Connector.
`static Counter`	`ORPHANED_NEW_PARTITION_CLEANED_COUNT` Counter for the total number of orphaned new partitions cleaned up.
`static Counter`	`PARTITION_MERGE_COUNT` Counter for the total number of partition merges identified during the execution of the Connector.
`static Counter`	`PARTITION_RECONCILED_WITH_TOKEN_COUNT` Counter for the total number of partitions reconciled with continuation tokens.
`static Counter`	`PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT` Counter for the total number of partitions reconciled without continuation tokens.
`static Counter`	`PARTITION_SPLIT_COUNT` Counter for the total number of partition splits / moves identified during the execution of the Connector.
`static Counter`	`PARTITION_STREAM_COUNT` Counter for the total number of active partitions being streamed.
`static Distribution`	`PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP` Distribution for measuring processing delay from commit timestamp.

Constructor Summary

Constructors
Constructor and Description

ChangeStreamMetrics()

Constructors
Constructor and Description
`ChangeStreamMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decPartitionStreamCount()` Decrements the `PARTITION_STREAM_COUNT` by 1.
`void`	`incChangeStreamMutationGcCounter()` Increments the `CHANGE_STREAM_MUTATION_GC_COUNT` by 1 if the metric is enabled.
`void`	`incChangeStreamMutationUserCounter()` Increments the `CHANGE_STREAM_MUTATION_USER_COUNT` by 1 if the metric is enabled.
`void`	`incClosestreamCount()` Increments the `CLOSESTREAM_COUNT` by 1 if the metric is enabled.
`void`	`incHeartbeatCount()` Increments the `HEARTBEAT_COUNT` by 1 if the metric is enabled.
`void`	`incListPartitionsCount()` Increments the `LIST_PARTITIONS_COUNT` by 1 if the metric is enabled.
`void`	`incOrphanedNewPartitionCleanedCount()` Increments the `ORPHANED_NEW_PARTITION_CLEANED_COUNT` by 1.
`void`	`incPartitionMergeCount()` Increments the `PARTITION_MERGE_COUNT` by 1 if the metric is enabled.
`void`	`incPartitionReconciledWithoutTokenCount()` Increments the `PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT` by 1.
`void`	`incPartitionReconciledWithTokenCount()` Increments the `PARTITION_RECONCILED_WITH_TOKEN_COUNT` by 1.
`void`	`incPartitionSplitCount()` Increments the `PARTITION_SPLIT_COUNT` by 1 if the metric is enabled.
`void`	`incPartitionStreamCount()` Increments the `PARTITION_STREAM_COUNT` by 1.
`void`	`updateProcessingDelayFromCommitTimestamp(long durationInMilli)` Adds measurement of an instance for the `PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP`.

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

- Field Detail
  - LIST_PARTITIONS_COUNT
```
public static final Counter LIST_PARTITIONS_COUNT
```
    Counter for the total number of partitions identified during the execution of the Connector.
  - PARTITION_SPLIT_COUNT
```
public static final Counter PARTITION_SPLIT_COUNT
```
    Counter for the total number of partition splits / moves identified during the execution of the Connector.
  - PARTITION_MERGE_COUNT
```
public static final Counter PARTITION_MERGE_COUNT
```
    Counter for the total number of partition merges identified during the execution of the Connector.
  - PARTITION_RECONCILED_WITH_TOKEN_COUNT
```
public static final Counter PARTITION_RECONCILED_WITH_TOKEN_COUNT
```
    Counter for the total number of partitions reconciled with continuation tokens.
  - PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT
```
public static final Counter PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT
```
    Counter for the total number of partitions reconciled without continuation tokens.
  - ORPHANED_NEW_PARTITION_CLEANED_COUNT
```
public static final Counter ORPHANED_NEW_PARTITION_CLEANED_COUNT
```
    Counter for the total number of orphaned new partitions cleaned up.
  - HEARTBEAT_COUNT
```
public static final Counter HEARTBEAT_COUNT
```
    Counter for the total number of heartbeats identified during the execution of the Connector.
  - CLOSESTREAM_COUNT
```
public static final Counter CLOSESTREAM_COUNT
```
    Counter for the total number of heartbeats identified during the execution of the Connector.
  - CHANGE_STREAM_MUTATION_USER_COUNT
```
public static final Counter CHANGE_STREAM_MUTATION_USER_COUNT
```
    Counter for the total number of ChangeStreamMutations that are initiated by users (not garbage collection) identified during the execution of the Connector.
  - CHANGE_STREAM_MUTATION_GC_COUNT
```
public static final Counter CHANGE_STREAM_MUTATION_GC_COUNT
```
    Counter for the total number of ChangeStreamMutations that are initiated by garbage collection (not user initiated) identified during the execution of the Connector.
  - PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP
```
public static final Distribution PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP
```
    Distribution for measuring processing delay from commit timestamp.
  - PARTITION_STREAM_COUNT
```
public static final Counter PARTITION_STREAM_COUNT
```
    Counter for the total number of active partitions being streamed.
- Constructor Detail
  - ChangeStreamMetrics
```
public ChangeStreamMetrics()
```
- Method Detail
  - incListPartitionsCount
```
public void incListPartitionsCount()
```
    Increments the LIST_PARTITIONS_COUNT by 1 if the metric is enabled.
  - incPartitionSplitCount
```
public void incPartitionSplitCount()
```
    Increments the PARTITION_SPLIT_COUNT by 1 if the metric is enabled.
  - incPartitionMergeCount
```
public void incPartitionMergeCount()
```
    Increments the PARTITION_MERGE_COUNT by 1 if the metric is enabled.
  - incPartitionReconciledWithTokenCount
```
public void incPartitionReconciledWithTokenCount()
```
    Increments the PARTITION_RECONCILED_WITH_TOKEN_COUNT by 1.
  - incPartitionReconciledWithoutTokenCount
```
public void incPartitionReconciledWithoutTokenCount()
```
    Increments the PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT by 1.
  - incOrphanedNewPartitionCleanedCount
```
public void incOrphanedNewPartitionCleanedCount()
```
    Increments the ORPHANED_NEW_PARTITION_CLEANED_COUNT by 1.
  - incHeartbeatCount
```
public void incHeartbeatCount()
```
    Increments the HEARTBEAT_COUNT by 1 if the metric is enabled.
  - incClosestreamCount
```
public void incClosestreamCount()
```
    Increments the CLOSESTREAM_COUNT by 1 if the metric is enabled.
  - incChangeStreamMutationUserCounter
```
public void incChangeStreamMutationUserCounter()
```
    Increments the CHANGE_STREAM_MUTATION_USER_COUNT by 1 if the metric is enabled.
  - incChangeStreamMutationGcCounter
```
public void incChangeStreamMutationGcCounter()
```
    Increments the CHANGE_STREAM_MUTATION_GC_COUNT by 1 if the metric is enabled.
  - incPartitionStreamCount
```
public void incPartitionStreamCount()
```
    Increments the PARTITION_STREAM_COUNT by 1.
  - decPartitionStreamCount
```
public void decPartitionStreamCount()
```
    Decrements the PARTITION_STREAM_COUNT by 1.
  - updateProcessingDelayFromCommitTimestamp
```
public void updateProcessingDelayFromCommitTimestamp(long durationInMilli)
```
    Adds measurement of an instance for the PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP.

Class ChangeStreamMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LIST_PARTITIONS_COUNT

PARTITION_SPLIT_COUNT

PARTITION_MERGE_COUNT

PARTITION_RECONCILED_WITH_TOKEN_COUNT

PARTITION_RECONCILED_WITHOUT_TOKEN_COUNT

ORPHANED_NEW_PARTITION_CLEANED_COUNT

HEARTBEAT_COUNT

CLOSESTREAM_COUNT

CHANGE_STREAM_MUTATION_USER_COUNT

CHANGE_STREAM_MUTATION_GC_COUNT

PROCESSING_DELAY_FROM_COMMIT_TIMESTAMP

PARTITION_STREAM_COUNT

Constructor Detail

ChangeStreamMetrics

Method Detail

incListPartitionsCount

incPartitionSplitCount

incPartitionMergeCount

incPartitionReconciledWithTokenCount

incPartitionReconciledWithoutTokenCount

incOrphanedNewPartitionCleanedCount

incHeartbeatCount

incClosestreamCount

incChangeStreamMutationUserCounter

incChangeStreamMutationGcCounter

incPartitionStreamCount

decPartitionStreamCount

updateProcessingDelayFromCommitTimestamp