Skip to content

docs(node): Add nodeRuntimeMetricsIntegration documentation #17151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chargome merged 1 commit into from
Mar 31, 2026
Merged

docs(node): Add nodeRuntimeMetricsIntegration documentation #17151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/noderuntimemetrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: NodeRuntimeMetrics
description: "Collect Node.js runtime health metrics such as memory usage, CPU utilization, and event loop delay."
supported:
- javascript.node
- javascript.aws-lambda
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.hono
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.react-router
- javascript.astro
- javascript.tanstackstart-react
---

<Alert>

This integration only works in the Node.js runtime.

</Alert>

_Import name: `Sentry.nodeRuntimeMetricsIntegration`_

The `nodeRuntimeMetricsIntegration` periodically collects Node.js runtime health metrics and sends them to Sentry. Metrics include memory usage, CPU utilization, event loop delay, and process uptime.

```javascript
import * as Sentry from "@sentry/node";

Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [Sentry.nodeRuntimeMetricsIntegration()],
});
```

## Default Metrics

The following metrics are emitted every 30 seconds by default:

| Metric | Type | Unit | Description |
|---|---|---|---|
| `node.runtime.mem.rss` | gauge | byte | Resident Set Size — actual process memory footprint |
| `node.runtime.mem.heap_used` | gauge | byte | V8 heap currently in use |
| `node.runtime.mem.heap_total` | gauge | byte | Total V8 heap allocated |
| `node.runtime.cpu.utilization` | gauge | ratio | CPU time / wall-clock time ratio |
| `node.runtime.event_loop.delay.p50` | gauge | second | Median event loop delay |
| `node.runtime.event_loop.delay.p99` | gauge | second | 99th percentile event loop delay |
| `node.runtime.event_loop.utilization` | gauge | ratio | Fraction of time the event loop was active |
| `node.runtime.process.uptime` | counter | second | Cumulative process uptime |

## Options

### `collect`

_Type: `object`_

Configure which metrics to collect. You can enable opt-in metrics or disable default ones.

**Opt-in metrics (off by default):**

```javascript
Sentry.nodeRuntimeMetricsIntegration({
collect: {
cpuTime: true, // node.runtime.cpu.user + node.runtime.cpu.system
memExternal: true, // node.runtime.mem.external + node.runtime.mem.array_buffers
eventLoopDelayMin: true,
eventLoopDelayMax: true,
eventLoopDelayMean: true,
eventLoopDelayP90: true,
},
});
```

**Disabling default metrics:**

```javascript
Sentry.nodeRuntimeMetricsIntegration({
collect: {
uptime: false,
eventLoopDelayP50: false,
},
});
```

### `collectionIntervalMs`

_Type: `number`_

The interval in milliseconds between metric collections. Defaults to `30000` (30 seconds).

```javascript
Sentry.nodeRuntimeMetricsIntegration({
collectionIntervalMs: 60_000,
});
```
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.astro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.aws-lambda.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`lruMemoizerIntegration`](./lrumemoizer) | | | ✓ | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`mongoIntegration`](./mongo) | | | ✓ | |
| [`mongooseIntegration`](./mongoose) | | | ✓ | |
| [`mysqlIntegration`](./mysql) | | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`prismaIntegration`](./prisma) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.fastify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.gcp-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`lruMemoizerIntegration`](./lrumemoizer) | | | ✓ | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`mongoIntegration`](./mongo) | | | ✓ | |
| [`mongooseIntegration`](./mongoose) | | | ✓ | |
| [`mysqlIntegration`](./mysql) | | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.hapi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nestjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`vercelAiIntegration`](./vercelai) | ✓ | | ✓ | ✓ |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
| [`nativeNodeFetchIntegration`](./nodefetch) | ✓ | | ✓ | ✓ |
| [`nodeContextIntegration`](./nodecontext) | ✓ | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`onUncaughtExceptionIntegration`](./onuncaughtexception) | ✓ | ✓ | | |
| [`onUnhandledRejectionIntegration`](./unhandledrejection) | ✓ | ✓ | | |
| [`postgresIntegration`](./postgres) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nuxt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.remix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.solidstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.sveltekit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`fsIntegration`](./fs) | | | ✓ | |
| [`knexIntegration`](./knex) | | | ✓ | |
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeRuntimeMetricsIntegration`](./noderuntimemetrics) | | | | ✓ |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
Expand Down
Loading