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.
- Alphabetic
- By Inheritance
- PeriodSnapshotAccumulator
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
PeriodSnapshotAccumulator(duration: Duration, margin: Duration)
- duration
for how long to accumulate snapshots
- margin
error margin for expected reporting period
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(periodSnapshot: PeriodSnapshot): Option[PeriodSnapshot]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- def peek(): PeriodSnapshot
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )