Sentry for Node.js
Learn how to manually set up Sentry in your Node.js app and capture your first events.
You need:
- A Sentry account and project
- Your application up and running
- Node version
20.19.0or above. Node.js 22 needs22.12or higher, while Node.js 23 needs23.2or higher (>=20.19.0 <22.0.0 || >=22.12.0 <23.0.0 || >=23.2.0).
Run the command for your preferred package manager to add the Sentry SDK to your application:
npm install @sentry/node @sentry/profiling-node --save
npm install @sentry/node @sentry/profiling-node --save
yarn add @sentry/node @sentry/profiling-node
pnpm add @sentry/node @sentry/profiling-node
Error Monitoring starts working as soon as you call Sentry.init(). Logs and Application Metrics need no extra configuration, and you'll learn how to send them in steps #3 and #4. This guide also enables Tracing and Profiling.
To import and initialize Sentry, create a file named instrument.(js|mjs) in the root directory of your project and add the code shown below.
The snippet also turns on:
- Tracing: via
tracesSampleRate - Profiling: via
profileSessionSampleRateandnodeProfilingIntegration()
instrument.jsconst Sentry = require("@sentry/node");
const { nodeProfilingIntegration } = require("@sentry/profiling-node");
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
// Add our Profiling integration
nodeProfilingIntegration(),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Enables Profiling for every session.
profileSessionSampleRate: 1.0,
});
const Sentry = require("@sentry/node");
const { nodeProfilingIntegration } = require("@sentry/profiling-node");
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
// Add our Profiling integration
nodeProfilingIntegration(),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Enables Profiling for every session.
profileSessionSampleRate: 1.0,
});
import * as Sentry from "@sentry/node";
import { nodeProfilingIntegration } from "@sentry/profiling-node";
// Ensure to call this before importing any other modules!
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [
// Add our Profiling integration
nodeProfilingIntegration(),
],
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
// Enables Profiling for every session.
profileSessionSampleRate: 1.0,
});
Then, use the --import command line option and point it to your instrument.(js|mjs) file to load the module before the application starts:
node --import ./instrument.js app.js
node --import ./instrument.js app.js
node --import ./instrument.mjs app.mjs
If you are using a bundler like vite, you can also follow the bundler setup docs instead.
The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard.
Alternatively, take a look at our Uploading Source Maps documentation.
npx @sentry/wizard@latest -i sourcemaps
npx @sentry/wizard@latest -i sourcemaps
By default, the SDK sends user identity data (IP address, ID, and similar) and other data like HTTP bodies and URL query parameters. This will give you rich debugging context.
The SDK always filters sensitive values whose keys match a built-in denylist, such as auth or password, and sends [Filtered] instead.
To send less data, turn off the categories you don't need in the dataCollection option. For the full list of categories and their defaults, see the dataCollection options.
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Use Sentry.logger to send logs at different levels, such as info, warn, or error. You can pass any attributes you want and search or filter by them later. See Set Up Logs for all available logging methods and the syntax for formatting messages.
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
If you're already logging with another library, use an integration to capture those logs as Sentry Logs automatically:
consoleLoggingIntegrationforconsolecalls- Consola
- Pino
Use Sentry.metrics to send counters, gauges, and distributions from your app to Sentry. You can pass any attributes you want and search or filter by them later. See Set Up Metrics for all available metric types and configuration options.
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
On Node.js, nodeRuntimeMetricsIntegration also collects runtime health metrics automatically.
Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.
Add an intentional error to your main application file that Sentry will capture:
setTimeout(() => {
try {
foo();
} catch (e) {
Sentry.captureException(e);
}
}, 99);
setTimeout(() => {
try {
foo();
} catch (e) {
Sentry.captureException(e);
}
}, 99);
Finally, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).
At this point, you should have integrated Sentry into your application. Here's what to explore next:
- Explore practical guides on what to monitor, log, track, and investigate after setup
- Extend Sentry to your frontend using one of our frontend SDKs
- Set up Agent Tracing to monitor your AI systems
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").