MetricBuilder

Registers a new gauge metric that caches its value for a given duration.

Example:

import nl.grons.metrics4.scala._
import scala.concurrent.duration._
class UserRepository(db: Database) extends DefaultInstrumented {
 // Defines the gauge.
 metrics.cachedGauge("row-count", 5.minutes) {
   // Does a measurement at most once every 5 minutes.
   db.usersRowCount()
 }
}

Creates a new counter metric.

Registers a new gauge metric.

Example:

import nl.grons.metrics4.scala._
class SessionStore(cache: Cache) extends DefaultInstrumented {
 // Defines the gauge.
 metrics.gauge("cache-evictions") {
   // Does a measurement.
   cache.getEvictionsCount()
 }
}

Creates a new histogram metric.

Creates a new meter metric.

Registers a new gauge metric to which you can push values.

Example:

import nl.grons.metrics4.scala._
class ExternalCacheUpdater extends DefaultInstrumented {
 // Defines a push gauge
 private val cachedItemsCount = metrics.pushGauge[Int]("cached.items.count", 0)

 def updateExternalCache(): Unit = {
   val items = fetchItemsFromDatabase()
   pushItemsToExternalCache(items)
   // Pushes a new measurement to the gauge.
   cachedItemsCount.push(items.size)
 }
}

Registers a new gauge metric to which you can push values.

The reported value is reset to defaultValue after the timeout.

Example in which the last pushed measurement is reported for at most 10 minutes.

import nl.grons.metrics4.scala._
import scala.concurrent.duration._
class ExternalCacheUpdater extends DefaultInstrumented {
 // Defines a push gauge
 private val cachedItemsCount = metrics.pushGaugeWithTimeout[Int]("cached.items.count", 0, 10.minutes)

 def updateExternalCache(): Unit = {
   val items = fetchItemsFromDatabase()
   pushItemsToExternalCache(items)
   // Pushes a new measurement to the gauge.
   cachedItemsCount.push(items.size)
 }
}

Note: Cleanup of old values happens only on read. In the absence of a metric reporter or other reader, the last pushed value will continue to take space on the heap. As most values are very small (e.g. an Int), this should not matter much.

Creates a new timer metric.

Unregisters all gauges that were created through this builder.

Registers a new gauge metric that caches its value for a given duration.

Creates a new counter metric.

Registers a new gauge metric.

Creates a new histogram metric.

Creates a new meter metric.

Creates a new timer metric.