Package io.debezium.pipeline.metrics

Class DefaultSnapshotChangeEventSourceMetrics<P extends Partition>

java.lang.Object

io.debezium.metrics.Metrics

io.debezium.pipeline.metrics.PipelineMetrics<P>

io.debezium.pipeline.metrics.DefaultSnapshotChangeEventSourceMetrics<P>

All Implemented Interfaces:

ChangeEventSourceMetrics<P>, ChangeEventSourceMetricsMXBean, SnapshotChangeEventSourceMetrics<P>, SnapshotChangeEventSourceMetricsMXBean, CommonEventMetricsMXBean, QueueMetricsMXBean, SchemaMetricsMXBean, SnapshotMetricsMXBean, DataChangeEventListener<P>, SnapshotProgressListener<P>

@ThreadSafe
public class DefaultSnapshotChangeEventSourceMetrics<P extends Partition>
extends PipelineMetrics<P>
implements SnapshotChangeEventSourceMetrics<P>, SnapshotChangeEventSourceMetricsMXBean

The default implementation of metrics related to the snapshot phase of a connector.

Author:

Randall Hauch, Jiri Pechanec

Field Summary

Fields

Modifier and Type	Field	Description
private final SnapshotMeter	snapshotMeter

Fields inherited from class io.debezium.pipeline.metrics.PipelineMetrics

metadataProvider, taskContext

Constructor Summary

Constructors

Constructor	Description
DefaultSnapshotChangeEventSourceMetrics(T taskContext, ChangeEventQueueMetrics changeEventQueueMetrics, EventMetadataProvider metadataProvider)
DefaultSnapshotChangeEventSourceMetrics(T taskContext, ChangeEventQueueMetrics changeEventQueueMetrics, EventMetadataProvider metadataProvider, Map<String,String> tags)

Method Summary

Modifier and Type	Method	Description
void	currentChunk(P partition, String chunkId, Object[] chunkFrom, Object[] chunkTo)
void	currentChunk(P partition, String chunkId, Object[] chunkFrom, Object[] chunkTo, Object[] tableTo)
void	dataCollectionSnapshotCompleted(P partition, DataCollectionId dataCollectionId, long numRows)
String[]	getCapturedTables()
String	getChunkFrom()
String	getChunkId()
String	getChunkTo()
String[]	getMonitoredTables()	Deprecated. Superseded by the 'Captured Tables' metric.
int	getRemainingTableCount()
ConcurrentMap<String,Long>	getRowsScanned()
boolean	getSnapshotAborted()
boolean	getSnapshotCompleted()
long	getSnapshotDurationInSeconds()
boolean	getSnapshotRunning()
String	getTableFrom()
String	getTableTo()
int	getTotalTableCount()
void	monitoredDataCollectionsDetermined(P partition, Iterable<? extends DataCollectionId> dataCollectionIds)
void	reset()
void	rowsScanned(P partition, TableId tableId, long numRows)
void	snapshotAborted(P partition)
void	snapshotCompleted(P partition)
void	snapshotStarted(P partition)

Methods inherited from class io.debezium.pipeline.metrics.PipelineMetrics

getCurrentQueueSizeInBytes, getLastEvent, getMaxQueueSizeInBytes, getMilliSecondsSinceLastEvent, getNumberOfErroneousEvents, getNumberOfEventsFiltered, getQueueRemainingCapacity, getQueueTotalCapacity, getTotalNumberOfCreateEventsSeen, getTotalNumberOfDeleteEventsSeen, getTotalNumberOfEventsSeen, getTotalNumberOfUpdateEventsSeen, onConnectorEvent, onErroneousEvent, onErroneousEvent, onEvent, onFilteredEvent, onFilteredEvent

Methods inherited from class io.debezium.metrics.Metrics

metricName, metricName, register, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.debezium.pipeline.metrics.ChangeEventSourceMetrics

register, unregister

Methods inherited from interface io.debezium.pipeline.metrics.traits.CommonEventMetricsMXBean

getLastEvent, getMilliSecondsSinceLastEvent, getNumberOfErroneousEvents, getNumberOfEventsFiltered, getTotalNumberOfCreateEventsSeen, getTotalNumberOfDeleteEventsSeen, getTotalNumberOfEventsSeen, getTotalNumberOfUpdateEventsSeen

Methods inherited from interface io.debezium.pipeline.source.spi.DataChangeEventListener

onConnectorEvent, onErroneousEvent, onErroneousEvent, onEvent, onFilteredEvent, onFilteredEvent

Methods inherited from interface io.debezium.pipeline.metrics.traits.QueueMetricsMXBean

getCurrentQueueSizeInBytes, getMaxQueueSizeInBytes, getQueueRemainingCapacity, getQueueTotalCapacity

Field Details

snapshotMeter

private final SnapshotMeter snapshotMeter

Constructor Details

DefaultSnapshotChangeEventSourceMetrics

public DefaultSnapshotChangeEventSourceMetrics(T taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider)

DefaultSnapshotChangeEventSourceMetrics

public DefaultSnapshotChangeEventSourceMetrics(T taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider,
 Map<String,String> tags)

Method Details

getTotalTableCount

public int getTotalTableCount()

Specified by:

getTotalTableCount in interface SnapshotMetricsMXBean

getRemainingTableCount

public int getRemainingTableCount()

Specified by:

getRemainingTableCount in interface SnapshotMetricsMXBean

getSnapshotRunning

public boolean getSnapshotRunning()

Specified by:

getSnapshotRunning in interface SnapshotMetricsMXBean

getSnapshotCompleted

public boolean getSnapshotCompleted()

Specified by:

getSnapshotCompleted in interface SnapshotMetricsMXBean

getSnapshotAborted

public boolean getSnapshotAborted()

Specified by:

getSnapshotAborted in interface SnapshotMetricsMXBean

getSnapshotDurationInSeconds

public long getSnapshotDurationInSeconds()

Specified by:

getSnapshotDurationInSeconds in interface SnapshotMetricsMXBean

getMonitoredTables

@Deprecated
public String[] getMonitoredTables()

Deprecated.

Superseded by the 'Captured Tables' metric. Use getCapturedTables(). Scheduled for removal in a future release.

Specified by:

getMonitoredTables in interface ChangeEventSourceMetricsMXBean

getCapturedTables

public String[] getCapturedTables()

Specified by:

getCapturedTables in interface SchemaMetricsMXBean

monitoredDataCollectionsDetermined

public void monitoredDataCollectionsDetermined(P partition,
 Iterable<? extends DataCollectionId> dataCollectionIds)

Specified by:

monitoredDataCollectionsDetermined in interface SnapshotProgressListener<P extends Partition>

dataCollectionSnapshotCompleted

public void dataCollectionSnapshotCompleted(P partition,
 DataCollectionId dataCollectionId,
 long numRows)

Specified by:

dataCollectionSnapshotCompleted in interface SnapshotProgressListener<P extends Partition>

snapshotStarted

public void snapshotStarted(P partition)

Specified by:

snapshotStarted in interface SnapshotProgressListener<P extends Partition>

snapshotCompleted

public void snapshotCompleted(P partition)

Specified by:

snapshotCompleted in interface SnapshotProgressListener<P extends Partition>

snapshotAborted

public void snapshotAborted(P partition)

Specified by:

snapshotAborted in interface SnapshotProgressListener<P extends Partition>

rowsScanned

public void rowsScanned(P partition,
 TableId tableId,
 long numRows)

Specified by:

rowsScanned in interface SnapshotProgressListener<P extends Partition>

getRowsScanned

public ConcurrentMap<String,Long> getRowsScanned()

Specified by:

getRowsScanned in interface SnapshotMetricsMXBean

currentChunk

public void currentChunk(P partition,
 String chunkId,
 Object[] chunkFrom,
 Object[] chunkTo)

Specified by:

currentChunk in interface SnapshotProgressListener<P extends Partition>

currentChunk

public void currentChunk(P partition,
 String chunkId,
 Object[] chunkFrom,
 Object[] chunkTo,
 Object[] tableTo)

Specified by:

currentChunk in interface SnapshotProgressListener<P extends Partition>

getChunkId

public String getChunkId()

Specified by:

getChunkId in interface SnapshotMetricsMXBean

getChunkFrom

public String getChunkFrom()

Specified by:

getChunkFrom in interface SnapshotMetricsMXBean

getChunkTo

public String getChunkTo()

Specified by:

getChunkTo in interface SnapshotMetricsMXBean

getTableFrom

public String getTableFrom()

Specified by:

getTableFrom in interface SnapshotMetricsMXBean

getTableTo

public String getTableTo()

Specified by:

getTableTo in interface SnapshotMetricsMXBean

reset

public void reset()

Specified by:

reset in interface ChangeEventSourceMetricsMXBean

Overrides:

reset in class PipelineMetrics<P extends Partition>