Package io.debezium.relational.history

Class SchemaHistoryMetrics

java.lang.Object

io.debezium.metrics.Metrics

io.debezium.relational.history.SchemaHistoryMetrics

All Implemented Interfaces:

SchemaHistoryListener, SchemaHistoryMXBean

public class SchemaHistoryMetrics
extends Metrics
implements SchemaHistoryListener, SchemaHistoryMXBean

Implementation of DatabaseSchema metrics.

Author:

Jiri Pechanec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SchemaHistoryMetrics.SchemaHistoryStatus

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicLong	changesRecovered
private final Clock	clock
private static final String	CONTEXT_NAME
private HistoryRecord	lastAppliedChange
private final ElapsedTimeStrategy	lastChangeAppliedLogDelay
private Instant	lastChangeAppliedTimestamp
private final ElapsedTimeStrategy	lastChangeRecoveredLogDelay
private Instant	lastChangeRecoveredTimestamp
private HistoryRecord	lastRecoveredChange
private static final org.slf4j.Logger	LOGGER
private static final Duration	PAUSE_BETWEEN_LOG_MESSAGES
private Instant	recoveryStartTime
private SchemaHistoryMetrics.SchemaHistoryStatus	status
private AtomicLong	totalChangesApplied

Fields inherited from interface io.debezium.relational.history.SchemaHistoryListener

NOOP

Constructor Summary

Constructors

Constructor	Description
SchemaHistoryMetrics(CommonConnectorConfig connectorConfig, boolean multiPartitionMode)

Method Summary

Modifier and Type	Method	Description
long	getChangesApplied()
long	getChangesRecovered()
String	getLastAppliedChange()
String	getLastRecoveredChange()
long	getMilliSecondsSinceLastAppliedChange()
long	getMilliSecondsSinceLastRecoveredChange()
long	getRecoveryStartTime()
String	getStatus()	The schema history starts in STOPPED state.
void	onChangeApplied(HistoryRecord record)	Invoked for every change applied and not filtered.
void	onChangeFromHistory(HistoryRecord record)	Invoked for every change read from the history during recovery.
void	recoveryStarted()
void	recoveryStopped()
void	started()
void	stopped()

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

Field Details

CONTEXT_NAME

private static final String CONTEXT_NAME

See Also:

• Constant Field Values

PAUSE_BETWEEN_LOG_MESSAGES

private static final Duration PAUSE_BETWEEN_LOG_MESSAGES

LOGGER

private static final org.slf4j.Logger LOGGER

status

private SchemaHistoryMetrics.SchemaHistoryStatus status

recoveryStartTime

private Instant recoveryStartTime

changesRecovered

private AtomicLong changesRecovered

totalChangesApplied

private AtomicLong totalChangesApplied

lastChangeAppliedTimestamp

private Instant lastChangeAppliedTimestamp

lastChangeRecoveredTimestamp

private Instant lastChangeRecoveredTimestamp

lastAppliedChange

private HistoryRecord lastAppliedChange

lastRecoveredChange

private HistoryRecord lastRecoveredChange

clock

private final Clock clock

lastChangeAppliedLogDelay

private final ElapsedTimeStrategy lastChangeAppliedLogDelay

lastChangeRecoveredLogDelay

private final ElapsedTimeStrategy lastChangeRecoveredLogDelay

Constructor Details

SchemaHistoryMetrics

public SchemaHistoryMetrics(CommonConnectorConfig connectorConfig,
 boolean multiPartitionMode)

Method Details

getStatus

public String getStatus()

Description copied from interface: SchemaHistoryMXBean

The schema history starts in STOPPED state. Upon start it transitions to RECOVERING state. When all changes from stored history were applied then it switches to RUNNING state.

Maps to SchemaHistoryMetrics.SchemaHistoryStatus enum.

Specified by:

getStatus in interface SchemaHistoryMXBean

Returns:

schema history component state

getRecoveryStartTime

public long getRecoveryStartTime()

Specified by:

getRecoveryStartTime in interface SchemaHistoryMXBean

Returns:

time in epoch seconds when recovery has started

getChangesRecovered

public long getChangesRecovered()

Specified by:

getChangesRecovered in interface SchemaHistoryMXBean

Returns:

number of changes that were read during recovery phase

getChangesApplied

public long getChangesApplied()

Specified by:

getChangesApplied in interface SchemaHistoryMXBean

Returns:

number of changes that were applied during recovery phase increased by number of changes applied during runtime

getMilliSecondsSinceLastAppliedChange

public long getMilliSecondsSinceLastAppliedChange()

Specified by:

getMilliSecondsSinceLastAppliedChange in interface SchemaHistoryMXBean

Returns:

elapsed time in milliseconds since the last change was applied

getMilliSecondsSinceLastRecoveredChange

public long getMilliSecondsSinceLastRecoveredChange()

Specified by:

getMilliSecondsSinceLastRecoveredChange in interface SchemaHistoryMXBean

Returns:

elapsed time in milliseconds since the last record was recovered from history

getLastAppliedChange

public String getLastAppliedChange()

Specified by:

getLastAppliedChange in interface SchemaHistoryMXBean

Returns:

String representation of the last applied change

getLastRecoveredChange

public String getLastRecoveredChange()

Specified by:

getLastRecoveredChange in interface SchemaHistoryMXBean

Returns:

String representation of the last recovered change

started

public void started()

Specified by:

started in interface SchemaHistoryListener

stopped

public void stopped()

Specified by:

stopped in interface SchemaHistoryListener

recoveryStarted

public void recoveryStarted()

Specified by:

recoveryStarted in interface SchemaHistoryListener

recoveryStopped

public void recoveryStopped()

Specified by:

recoveryStopped in interface SchemaHistoryListener

onChangeFromHistory

public void onChangeFromHistory(HistoryRecord record)

Description copied from interface: SchemaHistoryListener

Invoked for every change read from the history during recovery.

Specified by:

onChangeFromHistory in interface SchemaHistoryListener

onChangeApplied

public void onChangeApplied(HistoryRecord record)

Description copied from interface: SchemaHistoryListener

Invoked for every change applied and not filtered.

Specified by:

onChangeApplied in interface SchemaHistoryListener