org.apache.beam.sdk.io.gcp.spanner.changestreams

Class ChangeStreamMetrics

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	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 java.lang.String	PARTITION_ID_ATTRIBUTE_LABEL Cloud Tracing label for Partition Tokens.
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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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	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_ID_ATTRIBUTE_LABEL

public static final java.lang.String PARTITION_ID_ATTRIBUTE_LABEL

Cloud Tracing label for Partition Tokens.

See Also:

Constant Field Values

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.

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.

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: PARTITION_RECORD_COUNT and DATA_RECORD_COUNT.

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.

incDataRecordCounter

public void incDataRecordCounter()

Increments the DATA_RECORD_COUNT by 1 if the metric is enabled.

incHeartbeatRecordCount

public void incHeartbeatRecordCount()

Increments the HEARTBEAT_RECORD_COUNT by 1 if the metric is enabled.