Interface Meter

All Superinterfaces:
Metric
All Known Implementing Classes:
DropwizardMeter

@LimitedPrivate("Coprocesssor") @Evolving public interface Meter extends Metric
A metric which measure the rate at which some operation is invoked.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    Returns the number of events.
    double
    Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
    double
    Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
    double
    Returns the mean rate at which events have occurred since the meter was created.
    double
    Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
    void
    Records one occurrence.
    void
    mark(long events)
    Records events occurrences.
  • Method Details

    • mark

      void mark()
      Records one occurrence.
    • mark

      void mark(long events)
      Records events occurrences.
      Parameters:
      events - Number of occurrences to record.
    • getCount

      long getCount()
      Returns the number of events.
      Returns:
      the number of events.
    • getMeanRate

      double getMeanRate()
      Returns the mean rate at which events have occurred since the meter was created.
      Returns:
      the mean rate at which events have occurred since the meter was created
    • getOneMinuteRate

      Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.

      This rate has the same exponential decay factor as the one-minute load average in the top Unix command.

      Returns:
      the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created
    • getFiveMinuteRate

      Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.

      This rate has the same exponential decay factor as the five-minute load average in the top Unix command.

      Returns:
      the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created
    • getFifteenMinuteRate

      Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.

      This rate has the same exponential decay factor as the fifteen-minute load average in the top Unix command.

      Returns:
      the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created