object PeriodSnapshot extends Serializable
- Alphabetic
- By Inheritance
- PeriodSnapshot
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
Accumulator extends AnyRef
Accumulates PeriodSnapshot instances over the specified period of time and produces a single PeriodSnapshot that merges all metrics and instruments accumulated during that period.
Accumulates PeriodSnapshot instances over the specified period of time and produces a single PeriodSnapshot that merges all metrics and instruments accumulated during that period. This class contains mutable state, is 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 want to protect from users configuring a more frequent metrics tick interval. Example:
class Reporter extends MetricsReporter { val accumulator = PeriodSnapshot.accumulator(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 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 can be obtained by calling the
.peek()
ing into the accumulator.
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
accumulator(period: Duration, margin: Duration, stalePeriod: Duration): Accumulator
Creates a new PeriodSnapshot accumulator that removes stale instruments and metrics after the provided stale period.
-
def
accumulator(period: Duration, margin: Duration): Accumulator
Creates a new PeriodSnapshot accumulator using the default Kamon clock as time source.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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( ... ) @native()