com.yammer.metrics.scala.Meter.scala Maven / Gradle / Ivy
package com.yammer.metrics.scala
/**
* A Scala façade class for Meter.
*/
class Meter(metric: com.yammer.metrics.core.Meter) {
/**
* Marks the occurrence of an event.
*/
def mark() {
metric.mark()
}
/**
* Marks the occurrence of a given number of events.
*/
def mark(count: Long) {
metric.mark(count)
}
/**
* Returns the meter's rate unit.
*/
def rateUnit = metric.rateUnit
/**
* Returns the type of events the meter is measuring.
*/
def eventType = metric.eventType
/**
* Returns the number of events which have been marked.
*/
def count = metric.count
/**
* 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.
*/
def fifteenMinuteRate = metric.fifteenMinuteRate
/**
* 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.
*/
def fiveMinuteRate = metric.fiveMinuteRate
/**
* Returns the mean rate at which events have occurred since the meter was
* created.
*/
def meanRate = metric.meanRate
/**
* 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.
*/
def oneMinuteRate = metric.oneMinuteRate
}