Uh oh!
There was an error while loading. Please reload this page.
feat(node): Add nodeRuntimeMetricsIntegration - #19923
Merged
Merged
Conversation
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 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
nodeRuntimeMetricsIntegrationnodeRuntimeMetricsIntegrationchargome
marked this pull request as ready for review
March 24, 2026 15:54
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Autofix Details
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.
Uh oh!
There was an error while loading. Please reload this page.
…ener Fixes the beforeExit listener to fire on every invocation in serverless warm starts (e.g. AWS Lambda). Also properly removes the old listener on re-init to avoid accumulation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
Lms24
reviewed
Mar 25, 2026
Lms24
left a comment
Member
There was a problem hiding this comment.
Nice! Had some questions/minor suggestions but nice! TIL about the event loop metrics.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Framework wrappers (SvelteKit, TanStack, etc.) already call flushIfServerless after each request handler. The beforeExit flush was redundant and introduced an infinite loop risk since Node.js re-emits beforeExit after async work completes. Metrics are sent by the periodic interval or the existing SDK flush infrastructure. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This was referenced Mar 25, 2026
…rtions in tests Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Uh oh!
There was an error while loading. Please reload this page.
…meMetricsIntegration Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…s in integration tests ArrayContaining items are matched with strict equals (subsetEquality is not propagated), so extra attributes like sentry.timestamp.sequence and server.address caused all arrayContaining matches to fail. Wrapping with expect.objectContaining allows extra keys. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Lms24
approved these changes
Mar 25, 2026
Lms24
left a comment
Member
There was a problem hiding this comment.
Thanks for adding my suggestions!
Uh oh!
There was an error while loading. Please reload this page.
chargome added a commit
that referenced
this pull request
Mar 27, 2026
Add E2E tests for `nodeRuntimeMetricsIntegration` (#19923) in two test applications: - **node-express-v5**: Enables the integration in the Express app's Sentry init and adds 4 tests verifying all 8 default runtime metrics are emitted with correct shape - **nextjs-16**: Enables the integration in the server config and adds the same 4 tests, verifying metrics flow through the Next.js server runtime Both test suites use `waitForMetric` from `@sentry-internal/test-utils` and validate metric type, unit, value, and attributes (including `sentry.origin: 'auto.node.runtime_metrics'`). The collection interval is set to 1 second to keep tests fast. Refs #19923 Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
chargome added a commit
to getsentry/sentry-docs
that referenced
this pull request
Mar 27, 2026
Document the new nodeRuntimeMetricsIntegration for collecting Node.js runtime health metrics (memory, CPU, event loop, uptime). Ref: getsentry/sentry-javascript#19923 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
6 tasks
github-actionsBot
added a commit
to getsentry/sentry-for-ai
that referenced
this pull request
Mar 30, 2026
…eMetricsIntegration Documents the new runtime metrics integrations introduced in sentry-javascript (getsentry/sentry-javascript#19923, #19979) which were missing from the skill. Co-Authored-By: claude-sonnet-4-6 <noreply@anthropic.com>
46 tasks
chargome added a commit
to getsentry/sentry-docs
that referenced
this pull request
Mar 31, 2026
## DESCRIBE YOUR PR Document the new `nodeRuntimeMetricsIntegration` added in getsentry/sentry-javascript#19923. Documents getsentry/sentry-javascript#19923 - Add integration documentation page with default/opt-in metrics table and configuration options - Add integration to all Node.js-based platform integration tables ## IS YOUR CHANGE URGENT? - [ ] Urgent deadline (GA date, etc.) - [ ] Other deadline - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
HazAT pushed a commit
to getsentry/sentry-for-ai
that referenced
this pull request
Apr 8, 2026
…eMetricsIntegration (#84) Documents the new runtime metrics integrations introduced in sentry-javascript (getsentry/sentry-javascript#19923, #19979) which were missing from the skill. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: claude-sonnet-4-6 <noreply@anthropic.com>
chargome added a commit
to getsentry/sentry
that referenced
this pull request
May 5, 2026
…113517) Add the Node.js Runtime Metrics prebuilt dashboard and its onboarding panel. Seven widgets: - Event Loop Utilization, CPU Utilization, Process Uptime (KPIs) - Memory Usage (RSS / heap total / heap used — area chart) - CPU Utilization Over Time (line) - HTTP Request Duration (p50 / p95 — line, spans dataset) Surfaces the `node.runtime.*` trace metrics emitted by `nodeRuntimeMetricsIntegration` (getsentry/sentry-javascript#19923) so users can monitor CPU, memory, and event loop health alongside request latency. Metric names, types, and aggregations are aligned with the SDK: - `max()` on the pre-computed p50/p99 event loop delay percentiles (averaging pre-computed percentiles is statistically incorrect). - `sum()` on `process.uptime` — the SDK emits elapsed-since-last-tick deltas as a counter, so summing across the window gives total process-seconds. Trade-off: users with transactions but no runtime metrics will see empty widgets rather than the onboarding panel. Onboarding: <img width="1714" height="1200" alt="Screenshot 2026-04-20 at 15 39 56" src="https://github.com/user-attachments/assets/2e539210-0207-4849-b0c7-afe5d945a6a1" /> Dashboard: <img width="2404" height="980" alt="Screenshot 2026-04-21 at 10 38 08" src="https://github.com/user-attachments/assets/46de8e4e-6f4f-4ad4-8069-63de9e5b5a98" /> depends on #113516 ref getsentry/sentry-javascript#19923 closes https://linear.app/getsentry/issue/DAIN-1532/create-prebuilt-nodejs-health-dashboard
cleptric pushed a commit
to getsentry/sentry
that referenced
this pull request
May 5, 2026
…113517) Add the Node.js Runtime Metrics prebuilt dashboard and its onboarding panel. Seven widgets: - Event Loop Utilization, CPU Utilization, Process Uptime (KPIs) - Memory Usage (RSS / heap total / heap used — area chart) - CPU Utilization Over Time (line) - HTTP Request Duration (p50 / p95 — line, spans dataset) Surfaces the `node.runtime.*` trace metrics emitted by `nodeRuntimeMetricsIntegration` (getsentry/sentry-javascript#19923) so users can monitor CPU, memory, and event loop health alongside request latency. Metric names, types, and aggregations are aligned with the SDK: - `max()` on the pre-computed p50/p99 event loop delay percentiles (averaging pre-computed percentiles is statistically incorrect). - `sum()` on `process.uptime` — the SDK emits elapsed-since-last-tick deltas as a counter, so summing across the window gives total process-seconds. Trade-off: users with transactions but no runtime metrics will see empty widgets rather than the onboarding panel. Onboarding: <img width="1714" height="1200" alt="Screenshot 2026-04-20 at 15 39 56" src="https://github.com/user-attachments/assets/2e539210-0207-4849-b0c7-afe5d945a6a1" /> Dashboard: <img width="2404" height="980" alt="Screenshot 2026-04-21 at 10 38 08" src="https://github.com/user-attachments/assets/46de8e4e-6f4f-4ad4-8069-63de9e5b5a98" /> depends on #113516 ref getsentry/sentry-javascript#19923 closes https://linear.app/getsentry/issue/DAIN-1532/create-prebuilt-nodejs-health-dashboard
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.)
Works out of the box — no special configuration needed. Metrics are sent by the periodic collection interval and flushed by the existing SDK flush infrastructure (framework wrappers like SvelteKit, TanStack Start, and
@sentry/aws-serverlessalready callflushIfServerlessafter each request handler). The interval isunref()-ed so it never prevents the process from exiting.Runtime compatibility
This integration is Node.js only. Bun and Deno will be addressed in separate integrations that use their respective native APIs.
Closes#19967 (added automatically)