instrument

Type Members

1. trait CollectionContext extends AnyRef

   

2. case class CompactHdrSnapshot(numberOfMeasurements: Long, compactRecords: Array[Long], unitMagnitude: Int, subBucketHalfCount: Int, subBucketHalfCountMagnitude: Int) extends Snapshot with Product with Serializable

   

3. trait Counter extends Instrument

   

4. case class CounterSnapshot(count: Long) extends Snapshot with Product with Serializable

   

5. case class DefaultInstrumentSettings(histogram: InstrumentSettings, minMaxCounter: InstrumentSettings, gauge: InstrumentSettings) extends Product with Serializable

   

6. class DefaultRefreshScheduler extends RefreshScheduler

   

   Default implementation of RefreshScheduler that simply uses an akka.actor.Scheduler to schedule tasks to be run in the provided ExecutionContext.

7. class DifferentialValueCollector extends CurrentValueCollector

   

   Helper for cases in which a gauge shouldn't store the current value of a observed value but the difference between the current observed value and the previously observed value.

   Helper for cases in which a gauge shouldn't store the current value of a observed value but the difference between the current observed value and the previously observed value. Should only be used if the observed value is always increasing or staying steady, but is never able to decrease.

   Note: The first time a value is collected, this wrapper will always return zero, afterwards, the difference between the current value and the last value will be returned.

8. trait Gauge extends Instrument

   

9. class HdrHistogram extends AtomicHistogram with Histogram with AtomicHistogramFieldsAccessor

   

   This implementation is meant to be used for real time data collection where data snapshots are taken often over time.

   This implementation is meant to be used for real time data collection where data snapshots are taken often over time. The collect(..) operation extracts all the recorded values from the histogram and resets the counts, but still leave it in a consistent state even in the case of concurrent modification while the snapshot is being taken.

10. trait Histogram extends Instrument

    

11. class HistogramBackedGauge extends Gauge

    

12. case class InstrumentCustomSettings(lowestDiscernibleValue: Option[Long], highestTrackableValue: Option[Long], precision: Option[Int], refreshInterval: Option[FiniteDuration]) extends Product with Serializable

    

13. case class InstrumentFactory(configurations: Map[String, InstrumentCustomSettings], defaults: DefaultInstrumentSettings, scheduler: RefreshScheduler) extends Product with Serializable

    

14. case class InstrumentSettings(dynamicRange: DynamicRange, refreshInterval: Option[FiniteDuration]) extends Product with Serializable

    

15. trait InstrumentSnapshot extends AnyRef

    

16. sealed trait InstrumentType extends AnyRef

    

17. class LazyRefreshScheduler extends RefreshScheduler

    

    RefreshScheduler implementation that accumulates all the scheduled actions until it is pointed to another refresh scheduler.

    RefreshScheduler implementation that accumulates all the scheduled actions until it is pointed to another refresh scheduler. Once it is pointed, all subsequent calls to schedule will immediately be scheduled in the pointed scheduler.

18. class LongAdderCounter extends Counter

    

19. case class Memory(factor: Double, label: String) extends UnitOfMeasurement with Product with Serializable

    

    UnitOfMeasurement representing computer memory space.

20. trait MinMaxCounter extends Instrument

    

21. class PaddedMinMaxCounter extends MinMaxCounter

    

22. trait RefreshScheduler extends AnyRef

    

23. case class Time(factor: Double, label: String) extends UnitOfMeasurement with Product with Serializable

    

    UnitOfMeasurement representing time.

24. trait UnitOfMeasurement extends AnyRef

    

    A UnitOfMeasurement implementation describes the magnitude of a quantity being measured, such as Time and computer Memory space.

    A UnitOfMeasurement implementation describes the magnitude of a quantity being measured, such as Time and computer Memory space. Kamon uses UnitOfMeasurement implementations just as a informative companion to metrics inside entity recorders and might be used to scale certain kinds of measurements in metric backends.