LogMinerMetrics (Debezium Connector for Oracle 1.4.1.Final API)

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

All Implemented Interfaces:: LogMinerMetricsMXBean

@ThreadSafe
public class LogMinerMetrics
extends io.debezium.metrics.Metrics
implements LogMinerMetricsMXBean

This class contains methods to be exposed via MBean server

Field Summary

Fields
Modifier and Type	Field and Description
`private AtomicInteger`	`batchSize`
`private AtomicReference<String[]>`	`currentLogFileName`
`private AtomicLong`	`currentScn`
`static int`	`DEFAULT_BATCH_SIZE`
`private static int`	`DEFAULT_HOURS_TO_KEEP_TRANSACTION`
`private static int`	`DEFAULT_SLEEP_TIME`
`private AtomicInteger`	`hoursToKeepTransaction`
`private AtomicReference<Duration>`	`lastBatchProcessingDuration`
`private AtomicInteger`	`lastCapturedDmlCount`
`private AtomicReference<Duration>`	`lastDurationOfFetchingQuery`
`private AtomicInteger`	`logMinerQueryCount`
`private static int`	`MAX_BATCH_SIZE`
`private static int`	`MAX_SLEEP_TIME`
`private AtomicReference<Duration>`	`maxBatchProcessingDuration`
`private AtomicLong`	`maxBatchProcessingThroughput`
`private AtomicLong`	`maxCapturedDmlCount`
`private AtomicReference<Duration>`	`maxDurationOfFetchingQuery`
`private AtomicInteger`	`millisecondToSleepBetweenMiningQuery`
`private static int`	`MIN_BATCH_SIZE`
`private static int`	`MIN_SLEEP_TIME`
`private AtomicLong`	`networkConnectionProblemsCounter`
`private AtomicBoolean`	`recordMiningHistory`
`private AtomicReference<String[]>`	`redoLogStatus`
`private static int`	`SLEEP_TIME_INCREMENT`
`private AtomicInteger`	`switchCounter`
`private AtomicReference<Duration>`	`totalBatchProcessingDuration`
`private AtomicInteger`	`totalCapturedDmlCount`
`private AtomicReference<Duration>`	`totalDurationOfFetchingQuery`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeBatchSize(boolean increment)`
`void`	`changeSleepingTime(boolean increment)` change sleeping time
`long`	`getAverageBatchProcessingThroughput()` This represents the average number of entries processed per second from LogMiner sessions.
`int`	`getBatchSize()` Maximum number of entries in Log Miner view to fetch.
`String[]`	`getCurrentRedoLogFileName()` Exposes current redo log file.
`Long`	`getCurrentScn()` Exposes current SCN in the database.
`long`	`getFetchingQueryCount()` Log Miner view query returns number of captured DML , Commit and Rollback.
`int`	`getHoursToKeepTransactionInBuffer()`
`long`	`getLastBatchProcessingDuration()`
`long`	`getLastBatchProcessingThroughput()` This represents the number of entries processed per second in the last LogMiner session.
`int`	`getLastCapturedDmlCount()`
`Long`	`getLastDurationOfFetchingQuery()` Log Miner view query returns number of captured DML , Commit and Rollback.
`long`	`getMaxBatchProcessingThroughput()` This represents the maximum number of entries processed per second from LogMiner sessions.
`Long`	`getMaxCapturedDmlInBatch()`
`Long`	`getMaxDurationOfFetchingQuery()`
`Integer`	`getMillisecondToSleepBetweenMiningQuery()`
`long`	`getNetworkConnectionProblemsCounter()`
`boolean`	`getRecordMiningHistory()` this flag indicates whether log mining is being recorded by `HistoryRecorder`
`String[]`	`getRedoLogStatus()` Exposes states of redo logs: current, active, inactive, unused ...
`int`	`getSwitchCounter()` fetches counter of redo switches for the last day.
`long`	`getTotalCapturedDmlCount()`
`void`	`incrementNetworkConnectionProblemsCounter()`
`void`	`reset()` Resets metrics.
`void`	`setBatchSize(int size)` this gives ability to manipulate number of entries in Log Miner view to fetch.
`void`	`setCurrentLogFileName(Set<String> names)`
`void`	`setCurrentScn(Long scn)`
`void`	`setHoursToKeepTransactionInBuffer(int hours)` Set the number of hours to retain transaction in buffer prior to abandoning
`void`	`setLastCapturedDmlCount(int dmlCount)`
`void`	`setLastDurationOfBatchCapturing(Duration lastDuration)`
`void`	`setLastDurationOfBatchProcessing(Duration lastDuration)`
`void`	`setMillisecondToSleepBetweenMiningQuery(Integer milliseconds)` sets number of milliseconds for connector to sleep before fetching another batch from the Log Miner view
`void`	`setRecordMiningHistory(boolean doRecording)` this flag turns on recording of captured incremental changes.
`void`	`setRedoLogStatus(Map<String,String> status)`
`void`	`setSwitchCount(int counter)`
`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
  - DEFAULT_BATCH_SIZE
```
public static final int DEFAULT_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_SLEEP_TIME
```
private static final int MAX_SLEEP_TIME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SLEEP_TIME
```
private static final int DEFAULT_SLEEP_TIME
```
    See Also:
    
    Constant Field Values
  - MIN_SLEEP_TIME
```
private static final int MIN_SLEEP_TIME
```
    See Also:
    
    Constant Field Values
  - MIN_BATCH_SIZE
```
private static final int MIN_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_BATCH_SIZE
```
private static final int MAX_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOURS_TO_KEEP_TRANSACTION
```
private static final int DEFAULT_HOURS_TO_KEEP_TRANSACTION
```
    See Also:
    
    Constant Field Values
  - SLEEP_TIME_INCREMENT
```
private static final int SLEEP_TIME_INCREMENT
```
    See Also:
    
    Constant Field Values
  - currentScn
```
private final AtomicLong currentScn
```
  - logMinerQueryCount
```
private final AtomicInteger logMinerQueryCount
```
  - totalCapturedDmlCount
```
private final AtomicInteger totalCapturedDmlCount
```
  - totalDurationOfFetchingQuery
```
private final AtomicReference<Duration> totalDurationOfFetchingQuery
```
  - lastCapturedDmlCount
```
private final AtomicInteger lastCapturedDmlCount
```
  - lastDurationOfFetchingQuery
```
private final AtomicReference<Duration> lastDurationOfFetchingQuery
```
  - maxCapturedDmlCount
```
private final AtomicLong maxCapturedDmlCount
```
  - maxDurationOfFetchingQuery
```
private final AtomicReference<Duration> maxDurationOfFetchingQuery
```
  - totalBatchProcessingDuration
```
private final AtomicReference<Duration> totalBatchProcessingDuration
```
  - lastBatchProcessingDuration
```
private final AtomicReference<Duration> lastBatchProcessingDuration
```
  - maxBatchProcessingDuration
```
private final AtomicReference<Duration> maxBatchProcessingDuration
```
  - maxBatchProcessingThroughput
```
private final AtomicLong maxBatchProcessingThroughput
```
  - currentLogFileName
```
private final AtomicReference<String[]> currentLogFileName
```
  - redoLogStatus
```
private final AtomicReference<String[]> redoLogStatus
```
  - switchCounter
```
private final AtomicInteger switchCounter
```
  - batchSize
```
private final AtomicInteger batchSize
```
  - millisecondToSleepBetweenMiningQuery
```
private final AtomicInteger millisecondToSleepBetweenMiningQuery
```
  - recordMiningHistory
```
private final AtomicBoolean recordMiningHistory
```
  - hoursToKeepTransaction
```
private final AtomicInteger hoursToKeepTransaction
```
  - networkConnectionProblemsCounter
```
private final AtomicLong networkConnectionProblemsCounter
```
- Constructor Detail
  - LogMinerMetrics
```
LogMinerMetrics(io.debezium.connector.common.CdcSourceTaskContext taskContext)
```
- Method Detail
  - reset
```
public void reset()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Resets metrics.
    
    Specified by:
    
    reset in interface LogMinerMetricsMXBean
  - setCurrentScn
```
public void setCurrentScn(Long scn)
```
  - setCurrentLogFileName
```
public void setCurrentLogFileName(Set<String> names)
```
  - setRedoLogStatus
```
public void setRedoLogStatus(Map<String,String> status)
```
  - setSwitchCount
```
public void setSwitchCount(int counter)
```
  - setLastCapturedDmlCount
```
public void setLastCapturedDmlCount(int dmlCount)
```
  - setLastDurationOfBatchCapturing
```
public void setLastDurationOfBatchCapturing(Duration lastDuration)
```
  - setLastDurationOfBatchProcessing
```
public void setLastDurationOfBatchProcessing(Duration lastDuration)
```
  - incrementNetworkConnectionProblemsCounter
```
public void incrementNetworkConnectionProblemsCounter()
```
  - getCurrentScn
```
public Long getCurrentScn()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Exposes current SCN in the database. This is very efficient query and will not affect overall performance
    
    Specified by:
    
    getCurrentScn in interface LogMinerMetricsMXBean
    
    Returns:
    
    current SCN
  - getTotalCapturedDmlCount
```
public long getTotalCapturedDmlCount()
```
    Specified by:
    
    getTotalCapturedDmlCount in interface LogMinerMetricsMXBean
    
    Returns:
    
    number of captured DML since the connector is up
  - getCurrentRedoLogFileName
```
public String[] getCurrentRedoLogFileName()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Exposes current redo log file. This is very efficient query and will not affect overall performance
    
    Specified by:
    
    getCurrentRedoLogFileName in interface LogMinerMetricsMXBean
    
    Returns:
    
    full path or NULL if an exception occurs.
  - getRedoLogStatus
```
public String[] getRedoLogStatus()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Exposes states of redo logs: current, active, inactive, unused ...
    
    Specified by:
    
    getRedoLogStatus in interface LogMinerMetricsMXBean
    
    Returns:
    
    array of: (redo log name | status) elements
  - getSwitchCounter
```
public int getSwitchCounter()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    fetches counter of redo switches for the last day. If this number is high , like once in 3 minutes, the troubleshooting on the database level is required.
    
    Specified by:
    
    getSwitchCounter in interface LogMinerMetricsMXBean
    
    Returns:
    
    counter
  - getLastDurationOfFetchingQuery
```
public Long getLastDurationOfFetchingQuery()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Log Miner view query returns number of captured DML , Commit and Rollback. This is what we call a batch.
    
    Specified by:
    
    getLastDurationOfFetchingQuery in interface LogMinerMetricsMXBean
    
    Returns:
    
    duration of the last batch fetching
  - getLastBatchProcessingDuration
```
public long getLastBatchProcessingDuration()
```
    Specified by:
    
    getLastBatchProcessingDuration in interface LogMinerMetricsMXBean
    
    Returns:
    
    time of processing the last captured batch
  - getMaxDurationOfFetchingQuery
```
public Long getMaxDurationOfFetchingQuery()
```
    Specified by:
    
    getMaxDurationOfFetchingQuery in interface LogMinerMetricsMXBean
    
    Returns:
    
    average duration of Log Miner view query
  - getMaxCapturedDmlInBatch
```
public Long getMaxCapturedDmlInBatch()
```
    Specified by:
    
    getMaxCapturedDmlInBatch in interface LogMinerMetricsMXBean
    
    Returns:
    
    max number of DML captured during connector start time
  - getLastCapturedDmlCount
```
public int getLastCapturedDmlCount()
```
    Specified by:
    
    getLastCapturedDmlCount in interface LogMinerMetricsMXBean
    
    Returns:
    
    number of captured DL during last mining session
  - getAverageBatchProcessingThroughput
```
public long getAverageBatchProcessingThroughput()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    This represents the average number of entries processed per second from LogMiner sessions. Entries include things such as DMLs, commits, rollbacks, etc.
    
    Specified by:
    
    getAverageBatchProcessingThroughput in interface LogMinerMetricsMXBean
    
    Returns:
    
    the average number of entries per second from LogMiner sessions
  - getLastBatchProcessingThroughput
```
public long getLastBatchProcessingThroughput()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    This represents the number of entries processed per second in the last LogMiner session. Entries include things such as DMLs, commits, rollbacks, etc.
    
    Specified by:
    
    getLastBatchProcessingThroughput in interface LogMinerMetricsMXBean
    
    Returns:
    
    the number of entries processed per second from last LogMiner session
  - getFetchingQueryCount
```
public long getFetchingQueryCount()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Log Miner view query returns number of captured DML , Commit and Rollback. This is what we call a batch.
    
    Specified by:
    
    getFetchingQueryCount in interface LogMinerMetricsMXBean
    
    Returns:
    
    number of all processed batches
  - getBatchSize
```
public int getBatchSize()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Maximum number of entries in Log Miner view to fetch. This is used to set the diapason of the SCN in mining query. If difference between "start SCN" and "end SCN" to mine exceeds this limit, end SCN will be set to "start SCN" + batchSize
    
    Specified by:
    
    getBatchSize in interface LogMinerMetricsMXBean
    
    Returns:
    
    the limit
  - getMillisecondToSleepBetweenMiningQuery
```
public Integer getMillisecondToSleepBetweenMiningQuery()
```
    Specified by:
    
    getMillisecondToSleepBetweenMiningQuery in interface LogMinerMetricsMXBean
    
    Returns:
    
    number of milliseconds for connector to sleep before fetching another batch from the Log Miner view
  - getRecordMiningHistory
```
public boolean getRecordMiningHistory()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    this flag indicates whether log mining is being recorded by HistoryRecorder
    
    Specified by:
    
    getRecordMiningHistory in interface LogMinerMetricsMXBean
  - getHoursToKeepTransactionInBuffer
```
public int getHoursToKeepTransactionInBuffer()
```
    Specified by:
    
    getHoursToKeepTransactionInBuffer in interface LogMinerMetricsMXBean
    
    Returns:
    
    the number of hours to keep transaction in buffer before abandoning
  - getMaxBatchProcessingThroughput
```
public long getMaxBatchProcessingThroughput()
```
    Description copied from interface: LogMinerMetricsMXBean
    
    This represents the maximum number of entries processed per second from LogMiner sessions. Entries include things such as DMLs, commits, rollbacks, etc.
    
    Specified by:
    
    getMaxBatchProcessingThroughput in interface LogMinerMetricsMXBean
    
    Returns:
    
    the maximum number of entries processed per second from LogMiner sessions
  - getNetworkConnectionProblemsCounter
```
public long getNetworkConnectionProblemsCounter()
```
    Specified by:
    
    getNetworkConnectionProblemsCounter in interface LogMinerMetricsMXBean
    
    Returns:
    
    the number of connection problems detected
  - setBatchSize
```
public void setBatchSize(int size)
```
    Description copied from interface: LogMinerMetricsMXBean
    
    this gives ability to manipulate number of entries in Log Miner view to fetch. It has limits to prevent abnormal values
    
    Specified by:
    
    setBatchSize in interface LogMinerMetricsMXBean
    
    Parameters:
    
    size - limit
  - setMillisecondToSleepBetweenMiningQuery
```
public void setMillisecondToSleepBetweenMiningQuery(Integer milliseconds)
```
    Description copied from interface: LogMinerMetricsMXBean
    
    sets number of milliseconds for connector to sleep before fetching another batch from the Log Miner view
    
    Specified by:
    
    setMillisecondToSleepBetweenMiningQuery in interface LogMinerMetricsMXBean
    
    Parameters:
    
    milliseconds - to sleep
  - changeSleepingTime
```
public void changeSleepingTime(boolean increment)
```
    Description copied from interface: LogMinerMetricsMXBean
    
    change sleeping time
    
    Specified by:
    
    changeSleepingTime in interface LogMinerMetricsMXBean
    
    Parameters:
    
    increment - true to add, false to deduct
  - changeBatchSize
```
public void changeBatchSize(boolean increment)
```
    Specified by:
    
    changeBatchSize in interface LogMinerMetricsMXBean
  - setRecordMiningHistory
```
public void setRecordMiningHistory(boolean doRecording)
```
    Description copied from interface: LogMinerMetricsMXBean
    
    this flag turns on recording of captured incremental changes. It creates an overhead on CPU and takes disk space
    
    Specified by:
    
    setRecordMiningHistory in interface LogMinerMetricsMXBean
    
    Parameters:
    
    doRecording - true - record
  - setHoursToKeepTransactionInBuffer
```
public void setHoursToKeepTransactionInBuffer(int hours)
```
    Description copied from interface: LogMinerMetricsMXBean
    
    Set the number of hours to retain transaction in buffer prior to abandoning
    
    Specified by:
    
    setHoursToKeepTransactionInBuffer in interface LogMinerMetricsMXBean
    
    Parameters:
    
    hours - the number of hours
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LogMinerMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.debezium.metrics.Metrics

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BATCH_SIZE

MAX_SLEEP_TIME

DEFAULT_SLEEP_TIME

MIN_SLEEP_TIME

MIN_BATCH_SIZE

MAX_BATCH_SIZE

DEFAULT_HOURS_TO_KEEP_TRANSACTION

SLEEP_TIME_INCREMENT

currentScn

logMinerQueryCount

totalCapturedDmlCount

totalDurationOfFetchingQuery

lastCapturedDmlCount

lastDurationOfFetchingQuery

maxCapturedDmlCount

maxDurationOfFetchingQuery

totalBatchProcessingDuration

lastBatchProcessingDuration

maxBatchProcessingDuration

maxBatchProcessingThroughput

currentLogFileName

redoLogStatus

switchCounter

batchSize

millisecondToSleepBetweenMiningQuery

recordMiningHistory

hoursToKeepTransaction

networkConnectionProblemsCounter

Constructor Detail

LogMinerMetrics

Method Detail

reset

setCurrentScn

setCurrentLogFileName

setRedoLogStatus

setSwitchCount

setLastCapturedDmlCount

setLastDurationOfBatchCapturing

setLastDurationOfBatchProcessing

incrementNetworkConnectionProblemsCounter

getCurrentScn

getTotalCapturedDmlCount

getCurrentRedoLogFileName

getRedoLogStatus

getSwitchCounter

getLastDurationOfFetchingQuery

getLastBatchProcessingDuration

getMaxDurationOfFetchingQuery

getMaxCapturedDmlInBatch

getLastCapturedDmlCount

getAverageBatchProcessingThroughput

getLastBatchProcessingThroughput

getFetchingQueryCount

getBatchSize

getMillisecondToSleepBetweenMiningQuery

getRecordMiningHistory

getHoursToKeepTransactionInBuffer

getMaxBatchProcessingThroughput

getNetworkConnectionProblemsCounter

setBatchSize

setMillisecondToSleepBetweenMiningQuery

changeSleepingTime

changeBatchSize

setRecordMiningHistory

setHoursToKeepTransactionInBuffer

toString