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.
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:
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.