ports/com.group7.metrics.batchmeans/AdaptiveRateBatchMeans

AdaptiveRateBatchMeans

class AdaptiveRateBatchMeans(durationUnit: DurationUnit, initialBatchInterval: Duration = 1.milliseconds, targetBatches: Int = 32) : AdaptiveBatchMeans

Rate Batch means is the correct way to report rate metrics. It does all the heavy lifting of calculating the rates over each batch when events come in.

Constructors

constructor(durationUnit: DurationUnit, initialBatchInterval: Duration = 1.milliseconds, targetBatches: Int = 32)

Properties

targetBatches

val targetBatches: Int

Target number of batches to maintain after collapsing.

Functions

batchCount

fun batchCount(): Int

Returns the current number of batches.

batchVariance

fun batchVariance(): Double

Returns the current variance of batch means.

mean

fun mean(): Double

Returns the current overall mean across all batch means.

onCloseBatch

fun onCloseBatch(callback: () -> Unit)

Registers a callback to be invoked each time a batch is closed/finalized.

update

fun update(currentTime: Instant)

Updates the batch means with a new event at the given simulation time.