TransactionalBufferMetrics (Debezium Connector for Oracle 1.4.0.Alpha1 API)

java.lang.Object
- io.debezium.metrics.Metrics
- - io.debezium.connector.oracle.logminer.TransactionalBufferMetrics

All Implemented Interfaces:: TransactionalBufferMetricsMXBean

@ThreadSafe
public class TransactionalBufferMetrics
extends io.debezium.metrics.Metrics
implements TransactionalBufferMetricsMXBean

This class contains MBean methods

Field Summary

Fields
Modifier and Type	Field and Description
`private AtomicReference<Set<String>>`	`abandonedTransactionIds`
`private AtomicInteger`	`activeTransactions`
`private AtomicReference<Duration>`	`averageLagsFromTheSource`
`private AtomicLong`	`capturedDmlCounter`
`private AtomicInteger`	`commitQueueCapacity`
`private AtomicLong`	`committedDmlCounter`
`private AtomicLong`	`committedScn`
`private AtomicLong`	`committedTransactions`
`private AtomicInteger`	`errorCounter`
`private AtomicReference<Duration>`	`lagFromTheSource`
`private AtomicReference<Duration>`	`maxLagFromTheSource`
`private static long`	`MILLIS_PER_SECOND`
`private AtomicReference<Duration>`	`minLagFromTheSource`
`private AtomicLong`	`oldestScn`
`private AtomicReference<Set<String>>`	`rolledBackTransactionIds`
`private AtomicLong`	`rolledBackTransactions`
`private AtomicInteger`	`scnFreezeCounter`
`private Instant`	`startTime`
`private AtomicLong`	`timeDifference`
`private AtomicInteger`	`warningCounter`

Constructor Summary

Constructors
Constructor and Description

TransactionalBufferMetrics(io.debezium.connector.common.CdcSourceTaskContext taskContext)

Constructors
Constructor and Description
`TransactionalBufferMetrics(io.debezium.connector.common.CdcSourceTaskContext taskContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`addAbandonedTransactionId(String transactionId)`
`(package private) void`	`addRolledBackTransactionId(String transactionId)`
`(package private) void`	`calculateLagMetrics(Instant changeTime)`
`Set<String>`	`getAbandonedTransactionIds()` This is to get list of removed transactions from the Transactional Buffer
`long`	`getAverageLagFromSource()` This is to get average value of the time difference between logging of source DB records into redo log and capturing it by Log Miner.
`long`	`getCapturedDmlCount()` exposes total number of captured DMLs
`long`	`getCapturedDmlThroughput()` Exposes average number of captured and parsed DML per second
`int`	`getCommitQueueCapacity()` Gets commit queue capacity.
`Long`	`getCommittedScn()` It shows last committed SCN
`long`	`getCommitThroughput()` Exposes average number of committed transactions per second
`int`	`getErrorCounter()` This is to get logged logError counter.
`long`	`getLagFromSource()` This is to get the lag between latest captured change timestamp in REDO LOG and time of it's placement in the buffer
`long`	`getMaxLagFromSource()` This is to get max value of the time difference between logging of source DB records into redo log and capturing it by Log Miner
`long`	`getMinLagFromSource()` This is to get min value of the time difference between logging of source DB records into redo log and capturing it by Log Miner
`int`	`getNumberOfActiveTransactions()` Exposes number of transaction, buffered in memory
`long`	`getNumberOfCommittedTransactions()` Exposes number of committed transactions
`long`	`getNumberOfRolledBackTransactions()` Exposes number of rolled back transactions
`Long`	`getOldestScn()` Exposes the oldest(smallest) SCN in the Transactional Buffer
`Set<String>`	`getRolledBackTransactionIds()` See which transactions were rolled back
`int`	`getScnFreezeCounter()` Get counter of encountered observations when SCN does not change in the offset.
`int`	`getWarningCounter()` This is to get logged warning counter
`(package private) void`	`incrementCapturedDmlCounter()`
`(package private) void`	`incrementCommittedDmlCounter(int counter)`
`(package private) void`	`incrementCommittedTransactions()`
`(package private) void`	`incrementErrorCounter()` This is to increase logged logError counter.
`(package private) void`	`incrementRolledBackTransactions()`
`(package private) void`	`incrementScnFreezeCounter()` This counter to accumulate number of encountered observations when SCN does not change in the offset.
`(package private) void`	`incrementWarningCounter()` This is to increase logged warning counter There are other ways to monitor the log, but this is just to check if there are any.
`void`	`reset()` action to reset some metrics
`(package private) void`	`setActiveTransactions(Integer counter)`
`(package private) void`	`setCommitQueueCapacity(int commitQueueCapacity)`
`void`	`setCommittedScn(Long scn)`
`(package private) void`	`setOldestScn(Long scn)`
`void`	`setTimeDifference(AtomicLong timeDifference)`
`String`	`toString()`

Methods inherited from class io.debezium.metrics.Metrics
metricName, register, unregister

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - oldestScn
```
private final AtomicLong oldestScn
```
  - committedScn
```
private final AtomicLong committedScn
```
  - lagFromTheSource
```
private final AtomicReference<Duration> lagFromTheSource
```
  - activeTransactions
```
private final AtomicInteger activeTransactions
```
  - rolledBackTransactions
```
private final AtomicLong rolledBackTransactions
```
  - committedTransactions
```
private final AtomicLong committedTransactions
```
  - capturedDmlCounter
```
private final AtomicLong capturedDmlCounter
```
  - committedDmlCounter
```
private final AtomicLong committedDmlCounter
```
  - commitQueueCapacity
```
private final AtomicInteger commitQueueCapacity
```
  - maxLagFromTheSource
```
private final AtomicReference<Duration> maxLagFromTheSource
```
  - minLagFromTheSource
```
private final AtomicReference<Duration> minLagFromTheSource
```
  - averageLagsFromTheSource
```
private final AtomicReference<Duration> averageLagsFromTheSource
```
  - abandonedTransactionIds
```
private final AtomicReference<Set<String>> abandonedTransactionIds
```
  - rolledBackTransactionIds
```
private final AtomicReference<Set<String>> rolledBackTransactionIds
```
  - startTime
```
private final Instant startTime
```
  - MILLIS_PER_SECOND
```
private static final long MILLIS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - timeDifference
```
private final AtomicLong timeDifference
```
  - errorCounter
```
private final AtomicInteger errorCounter
```
  - warningCounter
```
private final AtomicInteger warningCounter
```
  - scnFreezeCounter
```
private final AtomicInteger scnFreezeCounter
```
- Constructor Detail
  - TransactionalBufferMetrics
```
TransactionalBufferMetrics(io.debezium.connector.common.CdcSourceTaskContext taskContext)
```
- Method Detail
  - setOldestScn
```
void setOldestScn(Long scn)
```
  - setCommittedScn
```
public void setCommittedScn(Long scn)
```
  - setTimeDifference
```
public void setTimeDifference(AtomicLong timeDifference)
```
  - calculateLagMetrics
```
void calculateLagMetrics(Instant changeTime)
```
  - setActiveTransactions
```
void setActiveTransactions(Integer counter)
```
  - incrementRolledBackTransactions
```
void incrementRolledBackTransactions()
```
  - incrementCommittedTransactions
```
void incrementCommittedTransactions()
```
  - incrementCapturedDmlCounter
```
void incrementCapturedDmlCounter()
```
  - incrementCommittedDmlCounter
```
void incrementCommittedDmlCounter(int counter)
```
  - addAbandonedTransactionId
```
void addAbandonedTransactionId(String transactionId)
```
  - addRolledBackTransactionId
```
void addRolledBackTransactionId(String transactionId)
```
  - incrementErrorCounter
```
void incrementErrorCounter()
```
    This is to increase logged logError counter. There are other ways to monitor the log, but this is just to check if there are any.
  - incrementWarningCounter
```
void incrementWarningCounter()
```
    This is to increase logged warning counter There are other ways to monitor the log, but this is just to check if there are any.
  - incrementScnFreezeCounter
```
void incrementScnFreezeCounter()
```
    This counter to accumulate number of encountered observations when SCN does not change in the offset. This call indicates an uncommitted oldest transaction in the buffer.
  - getOldestScn
```
public Long getOldestScn()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes the oldest(smallest) SCN in the Transactional Buffer
    
    Specified by:
    
    getOldestScn in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    oldest SCN
  - getCommittedScn
```
public Long getCommittedScn()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    It shows last committed SCN
    
    Specified by:
    
    getCommittedScn in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    committed SCN
  - getNumberOfActiveTransactions
```
public int getNumberOfActiveTransactions()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes number of transaction, buffered in memory
    
    Specified by:
    
    getNumberOfActiveTransactions in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    number of currently buffered transactions
  - getNumberOfRolledBackTransactions
```
public long getNumberOfRolledBackTransactions()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes number of rolled back transactions
    
    Specified by:
    
    getNumberOfRolledBackTransactions in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    number of rolled back transaction in the in-memory buffer
  - getNumberOfCommittedTransactions
```
public long getNumberOfCommittedTransactions()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes number of committed transactions
    
    Specified by:
    
    getNumberOfCommittedTransactions in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    number of committed transaction in the in-memory buffer
  - getCommitThroughput
```
public long getCommitThroughput()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes average number of committed transactions per second
    
    Specified by:
    
    getCommitThroughput in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    average number of committed transactions per second in the in-memory buffer
  - getCapturedDmlThroughput
```
public long getCapturedDmlThroughput()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Exposes average number of captured and parsed DML per second
    
    Specified by:
    
    getCapturedDmlThroughput in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    average number of captured and parsed DML per second in the in-memory buffer
  - getCapturedDmlCount
```
public long getCapturedDmlCount()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    exposes total number of captured DMLs
    
    Specified by:
    
    getCapturedDmlCount in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    captured DML count
  - getLagFromSource
```
public long getLagFromSource()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get the lag between latest captured change timestamp in REDO LOG and time of it's placement in the buffer
    
    Specified by:
    
    getLagFromSource in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    lag in milliseconds
  - getMaxLagFromSource
```
public long getMaxLagFromSource()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get max value of the time difference between logging of source DB records into redo log and capturing it by Log Miner
    
    Specified by:
    
    getMaxLagFromSource in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    value in milliseconds
  - getMinLagFromSource
```
public long getMinLagFromSource()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get min value of the time difference between logging of source DB records into redo log and capturing it by Log Miner
    
    Specified by:
    
    getMinLagFromSource in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    value in milliseconds
  - getAverageLagFromSource
```
public long getAverageLagFromSource()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get average value of the time difference between logging of source DB records into redo log and capturing it by Log Miner. Average is calculated as summary of all lags / number of captured DB changes
    
    Specified by:
    
    getAverageLagFromSource in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    value in milliseconds
  - getAbandonedTransactionIds
```
public Set<String> getAbandonedTransactionIds()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get list of removed transactions from the Transactional Buffer
    
    Specified by:
    
    getAbandonedTransactionIds in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    count abandoned transaction ids
  - getRolledBackTransactionIds
```
public Set<String> getRolledBackTransactionIds()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    See which transactions were rolled back
    
    Specified by:
    
    getRolledBackTransactionIds in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    set of transaction IDs
  - getErrorCounter
```
public int getErrorCounter()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get logged logError counter.
    
    Specified by:
    
    getErrorCounter in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    the error counter
  - getWarningCounter
```
public int getWarningCounter()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    This is to get logged warning counter
    
    Specified by:
    
    getWarningCounter in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    the warning counter
  - getScnFreezeCounter
```
public int getScnFreezeCounter()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Get counter of encountered observations when SCN does not change in the offset.
    
    Specified by:
    
    getScnFreezeCounter in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    the scn freeze counter
  - getCommitQueueCapacity
```
public int getCommitQueueCapacity()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    Gets commit queue capacity. As the queue fills up, this reduces to zero
    
    Specified by:
    
    getCommitQueueCapacity in interface TransactionalBufferMetricsMXBean
    
    Returns:
    
    the commit queue capacity
  - setCommitQueueCapacity
```
void setCommitQueueCapacity(int commitQueueCapacity)
```
  - reset
```
public void reset()
```
    Description copied from interface: TransactionalBufferMetricsMXBean
    
    action to reset some metrics
    
    Specified by:
    
    reset in interface TransactionalBufferMetricsMXBean
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TransactionalBufferMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.debezium.metrics.Metrics

Methods inherited from class java.lang.Object

Field Detail

oldestScn

committedScn

lagFromTheSource

activeTransactions

rolledBackTransactions

committedTransactions

capturedDmlCounter

committedDmlCounter

commitQueueCapacity

maxLagFromTheSource

minLagFromTheSource

averageLagsFromTheSource

abandonedTransactionIds

rolledBackTransactionIds

startTime

MILLIS_PER_SECOND

timeDifference

errorCounter

warningCounter

scnFreezeCounter

Constructor Detail

TransactionalBufferMetrics

Method Detail

setOldestScn

setCommittedScn

setTimeDifference

calculateLagMetrics

setActiveTransactions

incrementRolledBackTransactions

incrementCommittedTransactions

incrementCapturedDmlCounter

incrementCommittedDmlCounter

addAbandonedTransactionId

addRolledBackTransactionId

incrementErrorCounter

incrementWarningCounter

incrementScnFreezeCounter

getOldestScn

getCommittedScn

getNumberOfActiveTransactions

getNumberOfRolledBackTransactions

getNumberOfCommittedTransactions

getCommitThroughput

getCapturedDmlThroughput

getCapturedDmlCount

getLagFromSource

getMaxLagFromSource

getMinLagFromSource

getAverageLagFromSource

getAbandonedTransactionIds

getRolledBackTransactionIds

getErrorCounter

getWarningCounter

getScnFreezeCounter

getCommitQueueCapacity

setCommitQueueCapacity

reset

toString