Package io.debezium.pipeline.metrics

Class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

java.lang.Object

io.debezium.metrics.Metrics

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

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

All Implemented Interfaces:

ActivityMonitoringMXBean, ChangeEventSourceMetrics<P>, ChangeEventSourceMetricsMXBean, StreamingChangeEventSourceMetrics<P>, StreamingChangeEventSourceMetricsMXBean, CommonEventMetricsMXBean, ConnectionMetricsMXBean, QueueMetricsMXBean, SchemaMetricsMXBean, StreamingMetricsMXBean, StreamingStatisticsMXBean, DataChangeEventListener<P>, StreamingProgressListener

@ThreadSafe
public class DefaultStreamingChangeEventSourceMetrics<P extends Partition>
extends PipelineMetrics<P>
implements StreamingChangeEventSourceMetrics<P>, StreamingChangeEventSourceMetricsMXBean

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

Author:

Randall Hauch, Jiri Pechanec

Field Summary

Fields

Modifier and Type	Field	Description
private final ActivityMonitoringMeter	activityMonitoringMeter
private final ConnectionMeter	connectionMeter
private final StreamingMeter	streamingMeter

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

metadataProvider, taskContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	connected(boolean connected)
String[]	getCapturedTables()
String	getLastTransactionId()
long	getMilliSecondsBehindSource()
Double	getMilliSecondsBehindSourceAverageValue()
Long	getMilliSecondsBehindSourceMaxValue()
Long	getMilliSecondsBehindSourceMinValue()
Double	getMilliSecondsBehindSourceP50()
Double	getMilliSecondsBehindSourceP95()
Double	getMilliSecondsBehindSourceP99()
long	getNumberOfCommittedTransactions()
Map<String,Long>	getNumberOfCreateEventsSeen()
Map<String,Long>	getNumberOfDeleteEventsSeen()
Map<String,Long>	getNumberOfTruncateEventsSeen()
long	getNumberOfUnchangedEventsSkipped()
Map<String,Long>	getNumberOfUpdateEventsSeen()
Map<String,String>	getSourceEventPosition()
boolean	isConnected()
void	onConnectorEvent(P partition, ConnectorEvent event)	Invoked for events that represent a connector event.
void	onEvent(P partition, io.debezium.spi.schema.DataCollectionId source, OffsetContext offset, Object key, org.apache.kafka.connect.data.Struct value, Envelope.Operation operation)	Invoked if an event is processed for a captured table.
void	onUnchangedEventSkipped(P partition)
void	pause()
void	register()	Registers a metrics MBean into the platform MBean server.
void	reset()
void	resetLagBehindSource()
void	resume()
void	unregister()	Unregisters a metrics MBean from the platform MBean server.

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

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

Methods inherited from class io.debezium.metrics.Metrics

metricName, metricName

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.traits.CommonEventMetricsMXBean

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

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

onErroneousEvent, onErroneousEvent, onFilteredEvent, onFilteredEvent

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

getCurrentQueueSizeInBytes, getMaxQueueSizeInBytes, getQueueRemainingCapacity, getQueueTotalCapacity

Field Details

connectionMeter

private final ConnectionMeter connectionMeter

streamingMeter

private final StreamingMeter streamingMeter

activityMonitoringMeter

private final ActivityMonitoringMeter activityMonitoringMeter

Constructor Details

DefaultStreamingChangeEventSourceMetrics

public DefaultStreamingChangeEventSourceMetrics(T taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider,
 CapturedTablesSupplier capturedTablesSupplier)

DefaultStreamingChangeEventSourceMetrics

public DefaultStreamingChangeEventSourceMetrics(T taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider,
 Map<String,String> tags,
 CapturedTablesSupplier capturedTablesSupplier)

Method Details

register

public void register()

Description copied from class: Metrics

Registers a metrics MBean into the platform MBean server. The method is intentionally synchronized to prevent preemption between registration and unregistration.

Specified by:

register in interface ChangeEventSourceMetrics<P extends Partition>

Overrides:

register in class Metrics

unregister

public void unregister()

Description copied from class: Metrics

Unregisters a metrics MBean from the platform MBean server. The method is intentionally synchronized to prevent preemption between registration and unregistration.

Specified by:

unregister in interface ChangeEventSourceMetrics<P extends Partition>

Overrides:

unregister in class Metrics

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ConnectionMetricsMXBean

getCapturedTables

public String[] getCapturedTables()

Specified by:

getCapturedTables in interface SchemaMetricsMXBean

connected

public void connected(boolean connected)

Specified by:

connected in interface StreamingProgressListener

getSourceEventPosition

public Map<String,String> getSourceEventPosition()

Specified by:

getSourceEventPosition in interface StreamingMetricsMXBean

getMilliSecondsBehindSource

public long getMilliSecondsBehindSource()

Specified by:

getMilliSecondsBehindSource in interface StreamingMetricsMXBean

getMilliSecondsBehindSourceMinValue

public Long getMilliSecondsBehindSourceMinValue()

Specified by:

getMilliSecondsBehindSourceMinValue in interface StreamingStatisticsMXBean

getMilliSecondsBehindSourceMaxValue

public Long getMilliSecondsBehindSourceMaxValue()

Specified by:

getMilliSecondsBehindSourceMaxValue in interface StreamingStatisticsMXBean

getMilliSecondsBehindSourceAverageValue

public Double getMilliSecondsBehindSourceAverageValue()

Specified by:

getMilliSecondsBehindSourceAverageValue in interface StreamingStatisticsMXBean

getMilliSecondsBehindSourceP50

public Double getMilliSecondsBehindSourceP50()

Specified by:

getMilliSecondsBehindSourceP50 in interface StreamingStatisticsMXBean

getMilliSecondsBehindSourceP95

public Double getMilliSecondsBehindSourceP95()

Specified by:

getMilliSecondsBehindSourceP95 in interface StreamingStatisticsMXBean

getMilliSecondsBehindSourceP99

public Double getMilliSecondsBehindSourceP99()

Specified by:

getMilliSecondsBehindSourceP99 in interface StreamingStatisticsMXBean

getNumberOfCommittedTransactions

public long getNumberOfCommittedTransactions()

Specified by:

getNumberOfCommittedTransactions in interface StreamingMetricsMXBean

onEvent

public void onEvent(P partition,
 io.debezium.spi.schema.DataCollectionId source,
 OffsetContext offset,
 Object key,
 org.apache.kafka.connect.data.Struct value,
 Envelope.Operation operation)

Description copied from interface: DataChangeEventListener

Invoked if an event is processed for a captured table.

Specified by:

onEvent in interface DataChangeEventListener<P extends Partition>

Overrides:

onEvent in class PipelineMetrics<P extends Partition>

onConnectorEvent

public void onConnectorEvent(P partition,
 ConnectorEvent event)

Description copied from interface: DataChangeEventListener

Invoked for events that represent a connector event.

Specified by:

onConnectorEvent in interface DataChangeEventListener<P extends Partition>

Overrides:

onConnectorEvent in class PipelineMetrics<P extends Partition>

getLastTransactionId

public String getLastTransactionId()

Specified by:

getLastTransactionId in interface StreamingMetricsMXBean

resetLagBehindSource

public void resetLagBehindSource()

Specified by:

resetLagBehindSource in interface StreamingMetricsMXBean

reset

public void reset()

Specified by:

reset in interface ChangeEventSourceMetricsMXBean

Overrides:

reset in class PipelineMetrics<P extends Partition>

pause

public void pause()

Specified by:

pause in interface ActivityMonitoringMXBean

resume

public void resume()

Specified by:

resume in interface ActivityMonitoringMXBean

getNumberOfCreateEventsSeen

public Map<String,Long> getNumberOfCreateEventsSeen()

Specified by:

getNumberOfCreateEventsSeen in interface ActivityMonitoringMXBean

getNumberOfDeleteEventsSeen

public Map<String,Long> getNumberOfDeleteEventsSeen()

Specified by:

getNumberOfDeleteEventsSeen in interface ActivityMonitoringMXBean

getNumberOfUpdateEventsSeen

public Map<String,Long> getNumberOfUpdateEventsSeen()

Specified by:

getNumberOfUpdateEventsSeen in interface ActivityMonitoringMXBean

getNumberOfTruncateEventsSeen

public Map<String,Long> getNumberOfTruncateEventsSeen()

Specified by:

getNumberOfTruncateEventsSeen in interface ActivityMonitoringMXBean

getNumberOfUnchangedEventsSkipped

public long getNumberOfUnchangedEventsSkipped()

Specified by:

getNumberOfUnchangedEventsSkipped in interface StreamingMetricsMXBean

onUnchangedEventSkipped

public void onUnchangedEventSkipped(P partition)

Specified by:

onUnchangedEventSkipped in interface DataChangeEventListener<P extends Partition>