org.apache.flink.runtime.metrics

Class ThresholdMeter

java.lang.Object

org.apache.flink.runtime.metrics.ThresholdMeter

All Implemented Interfaces:

org.apache.flink.metrics.Meter, org.apache.flink.metrics.Metric

public class ThresholdMeter
extends Object
implements org.apache.flink.metrics.Meter

A timestamp queue based threshold meter.

Note: This class is thread safe, at the price of synchronization overhead. Do not use this in performance sensitive scenarios, e.g., per-record updated metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThresholdMeter.ThresholdExceedException Exception thrown when a threshold exceeds.

Constructor Summary

Constructors

Constructor and Description
ThresholdMeter(double maxEventsPerInterval, java.time.Duration interval)
ThresholdMeter(double maxEventsPerInterval, java.time.Duration interval, org.apache.flink.util.clock.Clock clock)

Method Summary

Modifier and Type	Method and Description
void	checkAgainstThreshold()
long	getCount()
double	getRate()
void	markEvent()
void	markEvent(long n)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThresholdMeter

public ThresholdMeter(double maxEventsPerInterval,
                      java.time.Duration interval)

ThresholdMeter

@VisibleForTesting
public ThresholdMeter(double maxEventsPerInterval,
                                         java.time.Duration interval,
                                         org.apache.flink.util.clock.Clock clock)

Method Detail

markEvent

public void markEvent()

Specified by:

markEvent in interface org.apache.flink.metrics.Meter

markEvent

public void markEvent(long n)

Specified by:

markEvent in interface org.apache.flink.metrics.Meter

getRate

public double getRate()

Specified by:

getRate in interface org.apache.flink.metrics.Meter

getCount

public long getCount()

Specified by:

getCount in interface org.apache.flink.metrics.Meter

checkAgainstThreshold

public void checkAgainstThreshold()
                           throws ThresholdMeter.ThresholdExceedException

Throws:

ThresholdMeter.ThresholdExceedException