Package io.debezium.pipeline.metrics

Class PipelineMetrics<P extends Partition>

java.lang.Object

io.debezium.metrics.Metrics

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

All Implemented Interfaces:

ChangeEventSourceMetricsMXBean, CommonEventMetricsMXBean, QueueMetricsMXBean, SchemaMetricsMXBean, DataChangeEventListener<P>

Direct Known Subclasses:

DefaultSnapshotChangeEventSourceMetrics, DefaultStreamingChangeEventSourceMetrics

@ThreadSafe
public abstract class PipelineMetrics<P extends Partition>
extends Metrics
implements DataChangeEventListener<P>, ChangeEventSourceMetricsMXBean

Base for metrics implementations.

Author:

Randall Hauch, Jiri Pechanec

Field Summary

Fields

Modifier and Type	Field	Description
private final ChangeEventQueueMetrics	changeEventQueueMetrics
private final CommonEventMeter	commonEventMeter
protected final EventMetadataProvider	metadataProvider
protected final CdcSourceTaskContext	taskContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PipelineMetrics(T taskContext, ChangeEventQueueMetrics changeEventQueueMetrics, EventMetadataProvider metadataProvider, Map<String,String> tags)
protected	PipelineMetrics(T taskContext, String contextName, ChangeEventQueueMetrics changeEventQueueMetrics, EventMetadataProvider metadataProvider)

Method Summary

Modifier and Type	Method	Description
long	getCurrentQueueSizeInBytes()
String	getLastEvent()
long	getMaxQueueSizeInBytes()
long	getMilliSecondsSinceLastEvent()
long	getNumberOfErroneousEvents()
long	getNumberOfEventsFiltered()
int	getQueueRemainingCapacity()
int	getQueueTotalCapacity()
long	getTotalNumberOfCreateEventsSeen()
long	getTotalNumberOfDeleteEventsSeen()
long	getTotalNumberOfEventsSeen()
long	getTotalNumberOfUpdateEventsSeen()
void	onConnectorEvent(P partition, ConnectorEvent event)	Invoked for events that represent a connector event.
void	onErroneousEvent(P partition, String event)	Invoked for events that cannot be processed.
void	onErroneousEvent(P partition, String event, Envelope.Operation operation)	Invoked for events that cannot be processed.
void	onEvent(P partition, 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	onFilteredEvent(P partition, String event)	Invoked for events pertaining to non-captured tables.
void	onFilteredEvent(P partition, String event, Envelope.Operation operation)	Invoked for events pertaining to non-captured tables.
void	reset()

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

getCapturedTables

Field Details

metadataProvider

protected final EventMetadataProvider metadataProvider

changeEventQueueMetrics

private final ChangeEventQueueMetrics changeEventQueueMetrics

taskContext

protected final CdcSourceTaskContext taskContext

commonEventMeter

private final CommonEventMeter commonEventMeter

Constructor Details

PipelineMetrics

protected PipelineMetrics(T taskContext,
 String contextName,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider)

PipelineMetrics

protected PipelineMetrics(T taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider metadataProvider,
 Map<String,String> tags)

Method Details

onEvent

public void onEvent(P partition,
 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>

onFilteredEvent

public void onFilteredEvent(P partition,
 String event)

Description copied from interface: DataChangeEventListener

Invoked for events pertaining to non-captured tables.

Specified by:

onFilteredEvent in interface DataChangeEventListener<P extends Partition>

onFilteredEvent

public void onFilteredEvent(P partition,
 String event,
 Envelope.Operation operation)

Description copied from interface: DataChangeEventListener

Invoked for events pertaining to non-captured tables.

Specified by:

onFilteredEvent in interface DataChangeEventListener<P extends Partition>

onErroneousEvent

public void onErroneousEvent(P partition,
 String event)

Description copied from interface: DataChangeEventListener

Invoked for events that cannot be processed.

Specified by:

onErroneousEvent in interface DataChangeEventListener<P extends Partition>

onErroneousEvent

public void onErroneousEvent(P partition,
 String event,
 Envelope.Operation operation)

Description copied from interface: DataChangeEventListener

Invoked for events that cannot be processed.

Specified by:

onErroneousEvent in interface DataChangeEventListener<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>

getLastEvent

public String getLastEvent()

Specified by:

getLastEvent in interface CommonEventMetricsMXBean

getMilliSecondsSinceLastEvent

public long getMilliSecondsSinceLastEvent()

Specified by:

getMilliSecondsSinceLastEvent in interface CommonEventMetricsMXBean

getTotalNumberOfEventsSeen

public long getTotalNumberOfEventsSeen()

Specified by:

getTotalNumberOfEventsSeen in interface CommonEventMetricsMXBean

getTotalNumberOfCreateEventsSeen

public long getTotalNumberOfCreateEventsSeen()

Specified by:

getTotalNumberOfCreateEventsSeen in interface CommonEventMetricsMXBean

getTotalNumberOfUpdateEventsSeen

public long getTotalNumberOfUpdateEventsSeen()

Specified by:

getTotalNumberOfUpdateEventsSeen in interface CommonEventMetricsMXBean

getTotalNumberOfDeleteEventsSeen

public long getTotalNumberOfDeleteEventsSeen()

Specified by:

getTotalNumberOfDeleteEventsSeen in interface CommonEventMetricsMXBean

getNumberOfEventsFiltered

public long getNumberOfEventsFiltered()

Specified by:

getNumberOfEventsFiltered in interface CommonEventMetricsMXBean

getNumberOfErroneousEvents

public long getNumberOfErroneousEvents()

Specified by:

getNumberOfErroneousEvents in interface CommonEventMetricsMXBean

reset

public void reset()

Specified by:

reset in interface ChangeEventSourceMetricsMXBean

getQueueTotalCapacity

public int getQueueTotalCapacity()

Specified by:

getQueueTotalCapacity in interface QueueMetricsMXBean

getQueueRemainingCapacity

public int getQueueRemainingCapacity()

Specified by:

getQueueRemainingCapacity in interface QueueMetricsMXBean

getMaxQueueSizeInBytes

public long getMaxQueueSizeInBytes()

Specified by:

getMaxQueueSizeInBytes in interface QueueMetricsMXBean

getCurrentQueueSizeInBytes

public long getCurrentQueueSizeInBytes()

Specified by:

getCurrentQueueSizeInBytes in interface QueueMetricsMXBean