Skip to main content

LatencyRecorder

@webda/bench


Class: LatencyRecorder

Defined in: packages/bench/src/stats.ts:28

Record latencies in a native histogram (perf_hooks.createHistogram)

Constructors​

Constructor​

new LatencyRecorder(): LatencyRecorder

Returns​

LatencyRecorder

Properties​

histogram​

protected histogram: RecordableHistogram

Defined in: packages/bench/src/stats.ts:32

Native histogram, in nanoseconds

Accessors​

count​

Get Signature​

get count(): number

Defined in: packages/bench/src/stats.ts:70

Number of recorded samples

Returns​

number

the count

Methods​

record()​

record(ns): void

Defined in: packages/bench/src/stats.ts:39

Record a duration

Parameters​

ns​

number | bigint

duration in nanoseconds; values below 1 are recorded as 1

Returns​

void


recordMs()​

recordMs(ms): void

Defined in: packages/bench/src/stats.ts:61

Record a duration in milliseconds

Parameters​

ms​

number

duration in milliseconds

Returns​

void


recordSince()​

recordSince(start): bigint

Defined in: packages/bench/src/stats.ts:50

Record the duration since a start time

Parameters​

start​

bigint

start time from now

Returns​

bigint

the duration in nanoseconds


reset()​

reset(): void

Defined in: packages/bench/src/stats.ts:77

Forget the recorded samples

Returns​

void


summary()​

summary(): LatencySummary

Defined in: packages/bench/src/stats.ts:86

Summary of the distribution

Returns​

LatencySummary

the summary in milliseconds, all zero when nothing was recorded