mirror of
https://github.com/oven-sh/bun
synced 2026-02-18 14:51:52 +00:00
## Summary This PR implements `perf_hooks.monitorEventLoopDelay()` for Node.js compatibility, enabling monitoring of event loop delays and collection of performance metrics via histograms. Fixes #17650 ## Implementation Details ### JavaScript Layer (`perf_hooks.ts`) - Added `IntervalHistogram` class with: - `enable()` / `disable()` methods with proper state tracking - `reset()` method to clear histogram data - Properties: `min`, `max`, `mean`, `stddev`, `exceeds`, `percentiles` - `percentile(p)` method with validation - Full input validation matching Node.js behavior (TypeError vs RangeError) ### C++ Bindings (`JSNodePerformanceHooksHistogramPrototype.cpp`) - `jsFunction_monitorEventLoopDelay` - Creates histogram for event loop monitoring - `jsFunction_enableEventLoopDelay` - Enables monitoring and starts timer - `jsFunction_disableEventLoopDelay` - Disables monitoring and stops timer - `JSNodePerformanceHooksHistogram_recordDelay` - Records delay measurements ### Zig Implementation (`EventLoopDelayMonitor.zig`) - Embedded `EventLoopTimer` that fires periodically based on resolution - Tracks last fire time and calculates delay between expected vs actual - Records delays > 0 to the histogram - Integrates seamlessly with existing Timer system ## Testing ✅ All tests pass: - Custom test suite with 8 comprehensive tests - Adapted Node.js core test for full compatibility - Tests cover enable/disable behavior, percentiles, error handling, and delay recording ## Test plan - [x] Run `bun test test/js/node/perf_hooks/test-monitorEventLoopDelay.test.js` - [x] Run adapted Node.js test `test/js/node/test/sequential/test-performance-eventloopdelay-adapted.test.js` - [x] Verify proper error handling for invalid arguments - [x] Confirm delay measurements are recorded correctly 🤖 Generated with [Claude Code](https://claude.ai/code) --------- Co-authored-by: Claude Bot <claude-bot@bun.sh> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
111 lines
2.8 KiB
JavaScript
111 lines
2.8 KiB
JavaScript
// Flags: --expose-gc --expose-internals
|
|
'use strict';
|
|
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const os = require('os');
|
|
const {
|
|
monitorEventLoopDelay
|
|
} = require('perf_hooks');
|
|
const sleep = typeof Bun === 'object' ? Bun.sleepSync : require('internal/util').sleep;
|
|
|
|
{
|
|
const histogram = monitorEventLoopDelay();
|
|
assert(histogram);
|
|
assert(histogram.enable());
|
|
assert(!histogram.enable());
|
|
histogram.reset();
|
|
assert(histogram.disable());
|
|
assert(!histogram.disable());
|
|
}
|
|
|
|
{
|
|
[null, 'a', 1, false, Infinity].forEach((i) => {
|
|
assert.throws(
|
|
() => monitorEventLoopDelay(i),
|
|
{
|
|
name: 'TypeError',
|
|
code: 'ERR_INVALID_ARG_TYPE'
|
|
}
|
|
);
|
|
});
|
|
|
|
[null, 'a', false, {}, []].forEach((i) => {
|
|
assert.throws(
|
|
() => monitorEventLoopDelay({ resolution: i }),
|
|
{
|
|
name: 'TypeError',
|
|
code: 'ERR_INVALID_ARG_TYPE'
|
|
}
|
|
);
|
|
});
|
|
|
|
[-1, 0, 2 ** 53, Infinity].forEach((i) => {
|
|
assert.throws(
|
|
() => monitorEventLoopDelay({ resolution: i }),
|
|
{
|
|
name: 'RangeError',
|
|
code: 'ERR_OUT_OF_RANGE'
|
|
}
|
|
);
|
|
});
|
|
}
|
|
|
|
{
|
|
const s390x = os.arch() === 's390x';
|
|
const histogram = monitorEventLoopDelay({ resolution: 1 });
|
|
histogram.enable();
|
|
let m = 5;
|
|
if (s390x) {
|
|
m = m * 2;
|
|
}
|
|
function spinAWhile() {
|
|
sleep(1000);
|
|
if (--m > 0) {
|
|
setTimeout(spinAWhile, common.platformTimeout(500));
|
|
} else {
|
|
histogram.disable();
|
|
// The values are non-deterministic, so we just check that a value is
|
|
// present, as opposed to a specific value.
|
|
assert(histogram.min > 0);
|
|
assert(histogram.max > 0);
|
|
assert(histogram.stddev > 0);
|
|
assert(histogram.mean > 0);
|
|
assert(histogram.percentiles.size > 0);
|
|
for (let n = 1; n < 100; n = n + 0.1) {
|
|
assert(histogram.percentile(n) >= 0);
|
|
}
|
|
histogram.reset();
|
|
assert.strictEqual(histogram.min, 9223372036854776000);
|
|
assert.strictEqual(histogram.max, 0);
|
|
assert(Number.isNaN(histogram.stddev));
|
|
assert(Number.isNaN(histogram.mean));
|
|
assert.strictEqual(histogram.percentiles.size, 1);
|
|
|
|
['a', false, {}, []].forEach((i) => {
|
|
assert.throws(
|
|
() => histogram.percentile(i),
|
|
{
|
|
name: 'TypeError',
|
|
code: 'ERR_INVALID_ARG_TYPE'
|
|
}
|
|
);
|
|
});
|
|
[-1, 0, 101, NaN].forEach((i) => {
|
|
assert.throws(
|
|
() => histogram.percentile(i),
|
|
{
|
|
name: 'RangeError',
|
|
code: 'ERR_OUT_OF_RANGE'
|
|
}
|
|
);
|
|
});
|
|
}
|
|
}
|
|
spinAWhile();
|
|
}
|
|
|
|
// Make sure that the histogram instances can be garbage-collected without
|
|
// and not just implicitly destroyed when the Environment is torn down.
|
|
process.on('exit', global.gc);
|