feat(node): Add nodeRuntimeMetricsIntegration#19923
Open
feat(node): Add nodeRuntimeMetricsIntegration#19923
nodeRuntimeMetricsIntegration#19923Conversation
Contributor
Semver Impact of This PR🟡 Minor (new features) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨Deps
Other
Bug Fixes 🐛Cloudflare
Core
Deps
Other
Internal Changes 🔧Deps Dev
Nuxt
Other
🤖 This preview updates automatically when you update the PR. |
Contributor
size-limit report 📦
|
Contributor
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
…google-cloud-serverless, skip for bun Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
chargome
changed the title
nodeRuntimeMetricsIntegrationnodeRuntimeMetricsIntegration
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix prepared a fix for the issue found in the latest run.
- ✅ Fixed:
process.onceprevents serverless flush after first invocation- Changed process.once to process.on so the beforeExit listener fires on every serverless invocation, not just the first one.
Or push these changes by commenting:
@cursor push 152bf6699a
Preview (152bf6699a)
diff --git a/packages/node-core/src/integrations/nodeRuntimeMetrics.ts b/packages/node-core/src/integrations/nodeRuntimeMetrics.ts
--- a/packages/node-core/src/integrations/nodeRuntimeMetrics.ts
+++ b/packages/node-core/src/integrations/nodeRuntimeMetrics.ts
@@ -202,7 +202,7 @@
// Collect and flush at the end of every invocation. In non-serverless environments
// flushIfServerless is a no-op, so this is safe to call unconditionally.
- process.once('beforeExit', () => {
+ process.on('beforeExit', () => {
collectMetrics();
void flushIfServerless();
});This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.
| process.once('beforeExit', () => { | ||
| collectMetrics(); | ||
| void flushIfServerless(); | ||
| }); |
There was a problem hiding this comment.
process.once prevents serverless flush after first invocation
High Severity
The beforeExit listener uses process.once instead of process.on, so it only fires on the first invocation. In serverless warm starts (e.g., AWS Lambda reusing the process), subsequent invocations never trigger the beforeExit flush. The comment on line 203 explicitly says "at the end of every invocation," and every other beforeExit listener in the codebase (e.g., processSession.ts, client.ts) uses process.on.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
nodeRuntimeMetricsIntegrationto@sentry/nodeand@sentry/node-core. When enabled, the integration periodically collects Node.js runtime health metrics and emits them to Sentry via the metrics pipeline.Usage
Default metrics (8)
Emitted every 30 seconds out of the box:
node.runtime.mem.rssnode.runtime.mem.heap_usednode.runtime.mem.heap_totalheap_usedto see headroomnode.runtime.cpu.utilizationnode.runtime.event_loop.delay.p50node.runtime.event_loop.delay.p99node.runtime.event_loop.utilizationnode.runtime.process.uptimeOpt-in metrics (off by default)
Any default metric can also be turned off:
Collection interval
Serverless (Next.js on Vercel, AWS Lambda, etc.)
In serverless environments the process is short-lived, so periodic intervals may never fire. The integration handles this automatically:
beforeExitlistener fires at the end of every invocation, collects a final snapshot of all metrics, and callsflushIfServerless()— which is a no-op in long-running servers but triggers an immediate flush on serverless platforms.setIntervalisunref()-ed so it never prevents the process from exiting between invocations.nodeRuntimeMetricsIntegration()call works in both environments.Runtime compatibility
This integration is Node.js only. Bun and Deno will be addressed in separate integrations that use their respective native APIs.
Closes #19881