kamon.metric

PeriodSnapshotAccumulator

class PeriodSnapshotAccumulator extends AnyRef

Merges snapshots over the specified duration and produces a snapshot with all merged metrics provided to it within the period. This class is mutable, not thread safe and assumes that all snapshots passed to the accumulate(...) function are ordered in time.

The typical use of this class would be when writing metric reporters that have to report data at a specific interval and wants to protect from users configuring a more frequent metrics tick interval. Example:

class Reporter extends MetricsReporter {
val accumulator = new PeriodSnapshotAccumulator(Duration.ofSeconds(60), Duration.ofSeconds(1))

def reportPeriodSnapshot(snapshot: PeriodSnapshot): Unit = {
  accumulator.add(snapshot).foreach(accumulatedSnapshot => {
    // Process your snapshot here, will only be called when the expected period has passed.
  }
}

...
}

The margin time is used to determine how close the current accumulated interval can to be to the expected interval and still get reported. In the example above a accumulated period of 59.6 seconds has a margin to 60 seconds of 0.4 seconds, thus, getting reported immediately instead of waiting for the next snapshot.

A detail of what has been accumulated by calling the .peek() function.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PeriodSnapshotAccumulator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PeriodSnapshotAccumulator(duration: Duration, margin: Duration)

    duration

    for how long to accumulate snapshots

    margin

    error margin for expected reporting period

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def add(periodSnapshot: PeriodSnapshot): Option[PeriodSnapshot]

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def peek(): PeriodSnapshot

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped