@sentry/node

What is @sentry/node?

The @sentry/node package is a tool designed for real-time monitoring and fixing crashes in Node.js applications. It provides error tracking and performance monitoring, helping developers to quickly identify, diagnose, and fix problems in their applications. Sentry integrates seamlessly with your existing codebase, offering a range of features to enhance application reliability and user experience.

What are @sentry/node's main functionalities?

Error Tracking

Automatically capture exceptions and errors in your Node.js applications. The code initializes Sentry with your project's DSN and demonstrates how an uncaught exception is automatically reported to Sentry.

const Sentry = require('@sentry/node');
Sentry.init({ dsn: 'YOUR_DSN_HERE' });

app.get('/', function mainHandler(req, res) {
  throw new Error('Broke!');
});

Performance Monitoring

Track the performance of your application, including request times and slow operations. This code sample starts a transaction, simulates an operation with a timeout, and then finishes the transaction, which is then reported to Sentry for performance analysis.

const Sentry = require('@sentry/node');
const transaction = Sentry.startTransaction({ op: 'test', name: 'My First Test Transaction' });

setTimeout(() => {
  transaction.finish();
}, 99);

Custom Event Capturing

Send custom messages or events to Sentry. This is useful for capturing non-exception events that are significant for your application's health monitoring and diagnostics.

const Sentry = require('@sentry/node');

Sentry.captureMessage('Something went wrong', 'error');

Other packages similar to @sentry/node

bugsnag-js

Bugsnag provides error monitoring for web, mobile, and server applications. Similar to @sentry/node, it offers real-time error reporting and allows for detailed error diagnostics and performance monitoring. Bugsnag differentiates itself with features tailored to mobile app monitoring.

rollbar

Rollbar offers real-time error tracking and debugging tools for developers. Like @sentry/node, it supports multiple programming languages and frameworks, including Node.js. Rollbar emphasizes its ability to help teams with workflow integrations and automated error grouping for efficient management.

raygun

Raygun provides crash reporting, real-user monitoring, and deployment tracking. It's similar to @sentry/node in its core functionalities of error tracking and performance monitoring but also offers unique features like user journey tracking and version comparisons to understand the impact of deployments.

README

Official Sentry SDK for Node

Installation

npm install @sentry/node

# Or yarn
yarn add @sentry/node

Usage

Sentry should be initialized as early in your app as possible. It is essential that you call Sentry.init before you require any other modules in your application, otherwise auto-instrumentation of these modules will not work.

You need to create a file named instrument.js that imports and initializes Sentry:

// CJS Syntax
const Sentry = require('@sentry/node');
// ESM Syntax
import * as Sentry from '@sentry/node';

Sentry.init({
  dsn: '__DSN__',
  // ...
});

You need to require or import the instrument.js file before importing any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:

// Import this first!
import './instrument';

// Now import other modules
import http from 'http';

// Your application code goes here

ESM Support

When running your application in ESM mode, you should use the Node.js --import command line option to ensure that Sentry is loaded before the application code is evaluated.

Adjust the Node.js call for your application to use the --import parameter and point it at instrument.js, which contains your Sentry.init() code:

# Note: This is only available for Node v18.19.0 onwards.
node --import ./instrument.mjs app.mjs

If it is not possible for you to pass the --import flag to the Node.js binary, you can alternatively use the NODE_OPTIONS environment variable as follows:

NODE_OPTIONS="--import ./instrument.mjs" npm run start

Links

• Official SDK Docs

Changelog

9.2.0

Important Changes

• feat(node): Support Express v5 (#15380)

This release adds full tracing support for Express v5, and improves tracing support for Nest.js 11 (which uses Express v5) in the Nest.js SDK.

• feat(sveltekit): Add Support for Cloudflare (#14672)

This release adds support for deploying SvelteKit applications to Cloudflare Pages. A docs update with updated instructions will follow shortly. Until then, you can give this a try by setting up the SvelteKit SDK as usual and then following the instructions outlined in the PR.

Thank you @SG60 for contributing this feature!

Other Changes

• feat(core): Add addLink(s) to Sentry span (#15452)
• feat(core): Add links to span options (#15453)
• feat(deps): Bump @sentry/webpack-plugin from 2.22.7 to 3.1.2 (#15328)
• feat(feedback): Disable Feedback submit & cancel buttons while submitting (#15408)
• feat(nextjs): Add experimental flag to not strip origin information from different origin stack frames (#15418)
• feat(nuxt): Add enableNitroErrorHandler to server options (#15444)
• feat(opentelemetry): Add addLink(s) to span (#15387)
• feat(opentelemetry): Add links to span options (#15403)
• feat(replay): Expose rrweb recordCrossOriginIframes under _experiments (#14916)
• fix(browser): Ensure that performance.measure spans have a positive duration (#15415)
• fix(bun): Includes correct sdk metadata (#15459)
• fix(core): Add Google gmo error to Inbound Filters (#15432)
• fix(core): Ensure http.client span descriptions don't contain query params or fragments (#15404)
• fix(core): Filter out unactionable Facebook Mobile browser error (#15430)
• fix(nestjs): Pin dependency on @opentelemetry/instrumentation (#15419)
• fix(nuxt): Only use filename with file extension from command (#15445)
• fix(nuxt): Use SentryNuxtServerOptions type for server init (#15441)
• fix(sveltekit): Avoid loading vite config to determine source maps setting (#15440)
• ref(profiling-node): Bump chunk interval to 60s (#15361)

Work in this release was contributed by @6farer, @dgavranic and @SG60. Thank you for your contributions!