A Histogram that is periodically updated on a given interval.

See also:

Methods

disable():Bool

Disables the update interval timer. Returns true if the timer was stopped, false if it was already stopped.

enable():Bool

Enables the update interval timer. Returns true if the timer was started, false if it was already started.

Inherited Variables

Defined by Histogram

read onlycount:Float

The number of samples recorded by the histogram.

read onlycountBigInt:Dynamic

The number of samples recorded by the histogram (as a BigInt).

// TODO: type as BigInt when hxnodejs provides one.

read onlyexceeds:Float

The number of times the event loop delay exceeded the maximum 1 hour event loop delay threshold.

read onlyexceedsBigInt:Dynamic

The number of times the event loop delay exceeded the maximum 1 hour event loop delay threshold (as a BigInt).

read onlymax:Float

The maximum recorded event loop delay.

read onlymaxBigInt:Dynamic

The maximum recorded event loop delay (as a BigInt).

read onlymean:Float

The mean of the recorded event loop delays.

read onlymin:Float

The minimum recorded event loop delay.

read onlyminBigInt:Dynamic

The minimum recorded event loop delay (as a BigInt).

read onlypercentiles:Map<Float, Float>

Returns a Map object detailing the accumulated percentile distribution.

read onlypercentilesBigInt:Dynamic

Returns a Map object detailing the accumulated percentile distribution (BigInt keys/values).

// TODO: type as Map when hxnodejs provides BigInt.

read onlystddev:Float

The standard deviation of the recorded event loop delays.

Inherited Methods

Defined by Histogram

percentile(percentile:Float):Float

Returns the value at the given percentile.

Parameters:

percentile

A percentile value in the range (0, 100].

percentileBigInt(percentile:Float):Dynamic

Returns the value at the given percentile (as a BigInt).

Parameters:

percentile

A percentile value in the range (0, 100].

reset():Void

Resets the collected histogram data.