Package io.debezium.connector.binlog.metrics

Class BinlogStreamingChangeEventSourceMetrics<T extends BinlogDatabaseSchema,P extends Partition>

java.lang.Object

io.debezium.metrics.Metrics

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

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

io.debezium.connector.binlog.metrics.BinlogStreamingChangeEventSourceMetrics<T,P>

All Implemented Interfaces:

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

public class BinlogStreamingChangeEventSourceMetrics<T extends BinlogDatabaseSchema,P extends Partition>
extends DefaultStreamingChangeEventSourceMetrics<P>
implements BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the streaming metrics for binlog-based connectors.

Author:

Chris Cranford

Field Summary

Fields

Modifier and Type	Field	Description
private final com.github.shyiko.mysql.binlog.BinaryLogClient	client
private final AtomicBoolean	isGtidModeEnabled
private final AtomicReference<String>	lastTransactionId
private final AtomicLong	milliSecondsBehindMaster
private final AtomicLong	numberOfCommittedTransactions
private final AtomicLong	numberOfLargeTransactions
private final AtomicLong	numberOfNotWellFormedTransactions
private final AtomicLong	numberOfRolledBackTransactions
private final T	schema
private final com.github.shyiko.mysql.binlog.jmx.BinaryLogClientStatistics	stats

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

metadataProvider, taskContext

Constructor Summary

Constructors

Constructor	Description
BinlogStreamingChangeEventSourceMetrics(BinlogTaskContext<T> taskContext, ChangeEventQueueMetrics changeEventQueueMetrics, EventMetadataProvider eventMetadataProvider)

Method Summary

Modifier and Type	Method	Description
String	getBinlogFilename()	Name of the current binlog file being read by underlying binlog client.
long	getBinlogPosition()	Current binlog offset position being read by underlying binlog client.
String[]	getCapturedTables()
String	getGtidSet()	Current global transaction identifier (GTID) being read by underlying binlog client.
boolean	getIsGtidModeEnabled()	Tracks if the connector is running using global transaction identifiers (GTID) to track current offset.
String	getLastEvent()
String	getLastTransactionId()
long	getMilliSecondsBehindSource()
long	getMilliSecondsSinceLastEvent()
long	getNumberOfCommittedTransactions()	Tracks the number of committed transactions.
long	getNumberOfDisconnects()	Tracks the number of times the underlying binlog client has been disconnected from the database.
long	getNumberOfLargeTransactions()	Tracks the number of transactions that contains events that had more entries than could be contained within the connectors binlog connector's instance.
long	getNumberOfNotWellFormedTransactions()	Tracks the number of transactions which are not well-formed.
long	getNumberOfRolledBackTransactions()	Tracks the number of rolled back transactions.
long	getNumberOfSkippedEvents()	Tracks the number of events skipped by underlying binlog client, generally due to the client being unable to properly deserialize the event.
Map<String,String>	getSourceEventPosition()
long	getTotalNumberOfEventsSeen()
boolean	isConnected()
void	onCommittedTransaction()
void	onGtidChange(String gtid)
void	onLargeTransaction()
void	onNotWellFormedTransaction()
void	onRolledBackTransaction()
void	reset()
void	setIsGtidModeEnabled(boolean enabled)
void	setMilliSecondsBehindSource(long value)

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

connected, onConnectorEvent, onEvent

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

getCurrentQueueSizeInBytes, getMaxQueueSizeInBytes, getNumberOfErroneousEvents, getNumberOfEventsFiltered, getQueueRemainingCapacity, getQueueTotalCapacity, getTotalNumberOfCreateEventsSeen, getTotalNumberOfDeleteEventsSeen, getTotalNumberOfUpdateEventsSeen, onErroneousEvent, onErroneousEvent, 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

getNumberOfErroneousEvents, getNumberOfEventsFiltered, getTotalNumberOfCreateEventsSeen, getTotalNumberOfDeleteEventsSeen, 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

client

private final com.github.shyiko.mysql.binlog.BinaryLogClient client

stats

private final com.github.shyiko.mysql.binlog.jmx.BinaryLogClientStatistics stats

schema

private final T extends BinlogDatabaseSchema schema

numberOfCommittedTransactions

private final AtomicLong numberOfCommittedTransactions

numberOfRolledBackTransactions

private final AtomicLong numberOfRolledBackTransactions

numberOfNotWellFormedTransactions

private final AtomicLong numberOfNotWellFormedTransactions

numberOfLargeTransactions

private final AtomicLong numberOfLargeTransactions

isGtidModeEnabled

private final AtomicBoolean isGtidModeEnabled

milliSecondsBehindMaster

private final AtomicLong milliSecondsBehindMaster

lastTransactionId

private final AtomicReference<String> lastTransactionId

Constructor Details

BinlogStreamingChangeEventSourceMetrics

public BinlogStreamingChangeEventSourceMetrics(BinlogTaskContext<T> taskContext,
 ChangeEventQueueMetrics changeEventQueueMetrics,
 EventMetadataProvider eventMetadataProvider)

Method Details

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ConnectionMetricsMXBean

Overrides:

isConnected in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getBinlogFilename

public String getBinlogFilename()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Name of the current binlog file being read by underlying binlog client.

Specified by:

getBinlogFilename in interface BinlogStreamingChangeEventSourceMetricsMXBean

getBinlogPosition

public long getBinlogPosition()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Current binlog offset position being read by underlying binlog client.

Specified by:

getBinlogPosition in interface BinlogStreamingChangeEventSourceMetricsMXBean

getGtidSet

public String getGtidSet()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Current global transaction identifier (GTID) being read by underlying binlog client.

Specified by:

getGtidSet in interface BinlogStreamingChangeEventSourceMetricsMXBean

getIsGtidModeEnabled

public boolean getIsGtidModeEnabled()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks if the connector is running using global transaction identifiers (GTID) to track current offset.

Specified by:

getIsGtidModeEnabled in interface BinlogStreamingChangeEventSourceMetricsMXBean

Returns:

true if using global transaction identifiers, false if not.

getLastEvent

public String getLastEvent()

Specified by:

getLastEvent in interface CommonEventMetricsMXBean

Overrides:

getLastEvent in class PipelineMetrics<P extends Partition>

getMilliSecondsSinceLastEvent

public long getMilliSecondsSinceLastEvent()

Specified by:

getMilliSecondsSinceLastEvent in interface CommonEventMetricsMXBean

Overrides:

getMilliSecondsSinceLastEvent in class PipelineMetrics<P extends Partition>

getTotalNumberOfEventsSeen

public long getTotalNumberOfEventsSeen()

Specified by:

getTotalNumberOfEventsSeen in interface CommonEventMetricsMXBean

Overrides:

getTotalNumberOfEventsSeen in class PipelineMetrics<P extends Partition>

getNumberOfSkippedEvents

public long getNumberOfSkippedEvents()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of events skipped by underlying binlog client, generally due to the client being unable to properly deserialize the event.

Specified by:

getNumberOfSkippedEvents in interface BinlogStreamingChangeEventSourceMetricsMXBean

getNumberOfDisconnects

public long getNumberOfDisconnects()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of times the underlying binlog client has been disconnected from the database.

Specified by:

getNumberOfDisconnects in interface BinlogStreamingChangeEventSourceMetricsMXBean

reset

public void reset()

Specified by:

reset in interface ChangeEventSourceMetricsMXBean

Overrides:

reset in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getNumberOfCommittedTransactions

public long getNumberOfCommittedTransactions()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of committed transactions.

Specified by:

getNumberOfCommittedTransactions in interface BinlogStreamingChangeEventSourceMetricsMXBean

Specified by:

getNumberOfCommittedTransactions in interface StreamingMetricsMXBean

Overrides:

getNumberOfCommittedTransactions in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getNumberOfRolledBackTransactions

public long getNumberOfRolledBackTransactions()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of rolled back transactions.

Specified by:

getNumberOfRolledBackTransactions in interface BinlogStreamingChangeEventSourceMetricsMXBean

getNumberOfNotWellFormedTransactions

public long getNumberOfNotWellFormedTransactions()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of transactions which are not well-formed. Example - The connector sees a commit-transaction event without a matching begin-transaction event.

Specified by:

getNumberOfNotWellFormedTransactions in interface BinlogStreamingChangeEventSourceMetricsMXBean

getNumberOfLargeTransactions

public long getNumberOfLargeTransactions()

Description copied from interface: BinlogStreamingChangeEventSourceMetricsMXBean

Tracks the number of transactions that contains events that had more entries than could be contained within the connectors binlog connector's instance.

Specified by:

getNumberOfLargeTransactions in interface BinlogStreamingChangeEventSourceMetricsMXBean

getCapturedTables

public String[] getCapturedTables()

Specified by:

getCapturedTables in interface SchemaMetricsMXBean

Overrides:

getCapturedTables in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getMilliSecondsBehindSource

public long getMilliSecondsBehindSource()

Specified by:

getMilliSecondsBehindSource in interface StreamingMetricsMXBean

Overrides:

getMilliSecondsBehindSource in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getSourceEventPosition

public Map<String,String> getSourceEventPosition()

Specified by:

getSourceEventPosition in interface StreamingMetricsMXBean

Overrides:

getSourceEventPosition in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

getLastTransactionId

public String getLastTransactionId()

Specified by:

getLastTransactionId in interface StreamingMetricsMXBean

Overrides:

getLastTransactionId in class DefaultStreamingChangeEventSourceMetrics<P extends Partition>

onCommittedTransaction

public void onCommittedTransaction()

onRolledBackTransaction

public void onRolledBackTransaction()

onNotWellFormedTransaction

public void onNotWellFormedTransaction()

onLargeTransaction

public void onLargeTransaction()

onGtidChange

public void onGtidChange(String gtid)

setIsGtidModeEnabled

public void setIsGtidModeEnabled(boolean enabled)

setMilliSecondsBehindSource

public void setMilliSecondsBehindSource(long value)