perf_hooks.IntervalHistogram

interface IntervalHistogram

• readonly count: number

  The number of samples recorded by the histogram.

• readonly countBigInt: bigint

  The number of samples recorded by the histogram. v17.4.0, v16.14.0

• readonly exceeds: number

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

• readonly exceedsBigInt: bigint

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

• readonly max: number

  The maximum recorded event loop delay.

• readonly maxBigInt: number

  The maximum recorded event loop delay. v17.4.0, v16.14.0

• readonly mean: number

  The mean of the recorded event loop delays.

• readonly min: number

  The minimum recorded event loop delay.

• readonly minBigInt: bigint

  The minimum recorded event loop delay. v17.4.0, v16.14.0

• readonly percentiles: Map<number, number>

  Returns a Map object detailing the accumulated percentile distribution.

• readonly percentilesBigInt: Map<bigint, bigint>

  Returns a Map object detailing the accumulated percentile distribution.

• readonly stddev: number

  The standard deviation of the recorded event loop delays.

• [Symbol.dispose](): void;

  Disables the update interval timer when the histogram is disposed.

  const { monitorEventLoopDelay } = require('node:perf_hooks');
  {
    using hist = monitorEventLoopDelay({ resolution: 20 });
    hist.enable();
    // The histogram will be disabled when the block is exited.
  }
  
• disable(): boolean;

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

• enable(): boolean;

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

• percentile(

  percentile: number

  ): number;

  Returns the value at the given percentile.

  @param percentile

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

• percentileBigInt(

  percentile: number

  ): bigint;

  Returns the value at the given percentile.

  @param percentile

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

• reset(): void;

  Resets the collected histogram data.