SiddhiBufferedEventsMetric (Siddhi Core 5.1.30 API)

java.lang.Object
- io.siddhi.core.util.statistics.metrics.SiddhiBufferedEventsMetric

All Implemented Interfaces:: BufferedEventsTracker

public class SiddhiBufferedEventsMetric
extends Object
implements BufferedEventsTracker

Class to calculate BufferedEvents in Siddhi.

Constructor Summary

Constructors
Constructor Description

SiddhiBufferedEventsMetric(com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`disableEventBufferHolderMetrics()`
`void`	`enableEventBufferHolderMetrics()`
`String`	`getName(EventBufferHolder eventBufferHolder)`
`void`	`registerEventBufferHolder(EventBufferHolder eventBufferHolder, String name)`	Register the EventBufferHolder that needs to be measured the used capacity usage

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

- Constructor Detail
  - SiddhiBufferedEventsMetric
```
public SiddhiBufferedEventsMetric(com.codahale.metrics.MetricRegistry metricRegistry)
```
- Method Detail
  - registerEventBufferHolder
```
public void registerEventBufferHolder(EventBufferHolder eventBufferHolder,
                                      String name)
```
    Register the EventBufferHolder that needs to be measured the used capacity usage
    
    Specified by:
    
    registerEventBufferHolder in interface BufferedEventsTracker
    
    Parameters:
    
    eventBufferHolder - EventBufferHolder
    
    name - An unique value to identify the object.
  - enableEventBufferHolderMetrics
```
public void enableEventBufferHolderMetrics()
```
    Specified by:
    
    enableEventBufferHolderMetrics in interface BufferedEventsTracker
  - disableEventBufferHolderMetrics
```
public void disableEventBufferHolderMetrics()
```
    Specified by:
    
    disableEventBufferHolderMetrics in interface BufferedEventsTracker
  - getName
```
public String getName(EventBufferHolder eventBufferHolder)
```
    Specified by:
    
    getName in interface BufferedEventsTracker
    
    Parameters:
    
    eventBufferHolder - Event buffer holder
    
    Returns:
    
    Name of the BufferedEvents tracker.