Metrics (Debezium Core 0.9.0.CR1 API)

java.lang.Object
- io.debezium.pipeline.metrics.Metrics

All Implemented Interfaces:

ChangeEventSourceMetricsMXBean, DataChangeEventListener

Direct Known Subclasses:

SnapshotChangeEventSourceMetrics, StreamingChangeEventSourceMetrics
```
@ThreadSafe
public abstract class Metrics
extends Object
implements DataChangeEventListener, ChangeEventSourceMetricsMXBean
```
Base for metrics implementations.

Author:

Randall Hauch, Jiri Pechanec

Field Summary

Fields
Modifier and Type	Field and Description
`protected Clock`	`clock`
`private String`	`contextName`
`private String`	`lastEvent`
`protected AtomicLong`	`lastEventTimestamp`
`private ObjectName`	`name`
`protected AtomicLong`	`numberOfEventsSkipped`
`protected CdcSourceTaskContext`	`taskContext`
`protected AtomicLong`	`totalNumberOfEventsSeen`

Fields inherited from interface io.debezium.pipeline.source.spi.DataChangeEventListener
NO_OP

Constructor Summary

Constructors
Modifier Constructor and Description

protected Metrics(T taskContext, String contextName)

Constructors
Modifier	Constructor and Description
`protected`	`Metrics(T taskContext, String contextName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getLastEvent()`
`long`	`getMilliSecondsSinceLastEvent()`
`long`	`getNumberOfEventsSkipped()`
`long`	`getTotalNumberOfEventsSeen()`
`void`	`onEvent(String event)` Invoked if an event is processed for a captured table.
`void`	`onSkippedEvent(String event)` Invoked for events pertaining to non-whitelisted tables.
`<T extends CdcSourceTaskContext> void`	`register(org.slf4j.Logger logger)` Registers a metrics MBean into the platform MBean server.
`void`	`reset()`
`void`	`unregister(org.slf4j.Logger logger)` Unregisters a metrics MBean from the platform MBean server.
`private void`	`updateCommonEventMetrics()`

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.ChangeEventSourceMetricsMXBean
getMonitoredTables

- Field Detail
  - totalNumberOfEventsSeen
```
protected final AtomicLong totalNumberOfEventsSeen
```
  - numberOfEventsSkipped
```
protected final AtomicLong numberOfEventsSkipped
```
  - lastEventTimestamp
```
protected final AtomicLong lastEventTimestamp
```
  - contextName
```
private final String contextName
```
  - clock
```
protected final Clock clock
```
  - taskContext
```
protected final CdcSourceTaskContext taskContext
```
  - name
```
private volatile ObjectName name
```
  - lastEvent
```
private volatile String lastEvent
```
- Constructor Detail
  - Metrics
```
protected Metrics(T taskContext,
                  String contextName)
```
- Method Detail
  - register
```
public <T extends CdcSourceTaskContext> void register(org.slf4j.Logger logger)
```
    Registers a metrics MBean into the platform MBean server. The method is intentionally synchronized to prevent preemption between registration and unregistration.
  - unregister
```
public final void unregister(org.slf4j.Logger logger)
```
    Unregisters a metrics MBean from the platform MBean server. The method is intentionally synchronized to prevent preemption between registration and unregistration.
  - onEvent
```
public void onEvent(String event)
```
    Description copied from interface: DataChangeEventListener
    
    Invoked if an event is processed for a captured table.
    
    Specified by:
    
    onEvent in interface DataChangeEventListener
  - updateCommonEventMetrics
```
private void updateCommonEventMetrics()
```
  - onSkippedEvent
```
public void onSkippedEvent(String event)
```
    Description copied from interface: DataChangeEventListener
    
    Invoked for events pertaining to non-whitelisted tables.
    
    Specified by:
    
    onSkippedEvent in interface DataChangeEventListener
  - getLastEvent
```
public String getLastEvent()
```
    Specified by:
    
    getLastEvent in interface ChangeEventSourceMetricsMXBean
  - getMilliSecondsSinceLastEvent
```
public long getMilliSecondsSinceLastEvent()
```
    Specified by:
    
    getMilliSecondsSinceLastEvent in interface ChangeEventSourceMetricsMXBean
  - getTotalNumberOfEventsSeen
```
public long getTotalNumberOfEventsSeen()
```
    Specified by:
    
    getTotalNumberOfEventsSeen in interface ChangeEventSourceMetricsMXBean
  - getNumberOfEventsSkipped
```
public long getNumberOfEventsSkipped()
```
    Specified by:
    
    getNumberOfEventsSkipped in interface ChangeEventSourceMetricsMXBean
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface ChangeEventSourceMetricsMXBean

Class Metrics

Field Summary

Fields inherited from interface io.debezium.pipeline.source.spi.DataChangeEventListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.debezium.pipeline.metrics.ChangeEventSourceMetricsMXBean

Field Detail

totalNumberOfEventsSeen

numberOfEventsSkipped

lastEventTimestamp

contextName

clock

taskContext

name

lastEvent

Constructor Detail

Metrics

Method Detail

register

unregister

onEvent

updateCommonEventMetrics

onSkippedEvent

getLastEvent

getMilliSecondsSinceLastEvent

getTotalNumberOfEventsSeen

getNumberOfEventsSkipped

reset