org.apache.kafka.common.metrics.stats

Class Meter

java.lang.Object

org.apache.kafka.common.metrics.stats.Meter

All Implemented Interfaces:

CompoundStat, Stat

public class Meter
extends Object
implements CompoundStat

A compound stat that includes a rate metric and a cumulative total metric.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.common.metrics.CompoundStat

CompoundStat.NamedMeasurable

Constructor Summary

Constructors

Constructor and Description
Meter(MetricName rateMetricName, MetricName totalMetricName) Construct a Meter with seconds as time unit
Meter(SampledStat rateStat, MetricName rateMetricName, MetricName totalMetricName) Construct a Meter with seconds as time unit
Meter(TimeUnit unit, MetricName rateMetricName, MetricName totalMetricName) Construct a Meter with provided time unit
Meter(TimeUnit unit, SampledStat rateStat, MetricName rateMetricName, MetricName totalMetricName) Construct a Meter with provided time unit

Method Summary

Modifier and Type	Method and Description
void	record(MetricConfig config, double value, long timeMs) Record the given value
List<CompoundStat.NamedMeasurable>	stats()

Methods inherited from class java.lang.Object

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

Constructor Detail

Meter

public Meter(MetricName rateMetricName,
             MetricName totalMetricName)

Construct a Meter with seconds as time unit

Meter

public Meter(TimeUnit unit,
             MetricName rateMetricName,
             MetricName totalMetricName)

Construct a Meter with provided time unit

Meter

public Meter(SampledStat rateStat,
             MetricName rateMetricName,
             MetricName totalMetricName)

Construct a Meter with seconds as time unit

Meter

public Meter(TimeUnit unit,
             SampledStat rateStat,
             MetricName rateMetricName,
             MetricName totalMetricName)

Construct a Meter with provided time unit

Method Detail

stats

public List<CompoundStat.NamedMeasurable> stats()

Specified by:

stats in interface CompoundStat

record

public void record(MetricConfig config,
                   double value,
                   long timeMs)

Description copied from interface: Stat

Record the given value

Specified by:

record in interface Stat

Parameters:

config - The configuration to use for this metric

value - The value to record

timeMs - The POSIX time in milliseconds this value occurred