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.
Official Sentry SDK for Node
Installation
npm install @sentry/node
yarn add @sentry/node
Usage
const Sentry = require('@sentry/node');
import * as Sentry from '@sentry/node';
Sentry.init({
dsn: '__DSN__',
});
Note that it is necessary to initialize Sentry before you import any package that may be instrumented by us.
More information on how to set up Sentry for Node in v8.
ESM Support
Due to the way OpenTelemetry handles instrumentation, this only works out of the box for CommonJS (require
)
applications.
There is experimental support for running OpenTelemetry with ESM ("type": "module"
):
node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ./app.js
You'll need to install @opentelemetry/instrumentation
in your app to ensure this works.
See
OpenTelemetry Instrumentation Docs
for details on this - but note that this is a) experimental, and b) does not work with all integrations.
Links
8.8.0
- feat: Upgrade OTEL dependencies (#12388)
This upgrades the OpenTelemetry dependencies to the latest versions and makes OTEL use import-in-the-middle
v1.8.0
.
This should fix numerous issues with using OTEL instrumentation with ESM.
High level issues fixed with OTEL + ESM:
- incompatibilities with using multiple loaders, commonly encountered while using
tsx
or similar libraries. - incompatibilities with libraries that use duplicate namespace exports like
date-fns
. - incompatibilities with libraries that use self-referencing namespace imports like
openai
. - incompatibilities with dynamic export patterns like exports with function calls.
ENOENT: no such file or directory
bugs that libraries like discord.js
surface.
If you are still encountering issues with OpenTelemetry instrumentation and ESM, please let us know.
- deps: Bump Sentry bundler plugins to version
2.18.0
(#12381) - feat: Add
thirdPartyErrorFilterIntegration
(#12267) - feat(core): Filter out error events with exception values and no stacktraces, values, or types (#12387)
- feat(core): Ignore additional common but inactionable errors (#12384)
- feat(deps): Bump @opentelemetry/propagator-aws-xray from 1.3.1 to 1.24.1 (#12333)
- feat(deps): Bump @sentry/cli from 2.31.2 to 2.32.1 (#12332)
- feat(redis): Support
mget
command in caching functionality (#12380) - feat(vercel-edge): Export core integrations from Vercel edge SDK (#12308)
- fix(browser): Fix idle span ending (#12306)
- fix(browser): Fix parenthesis parsing logic for chromium (#12373)
- fix(browser): Fix types export path for CJS (#12305)
- fix(feedback): Override TriggerLabel Option (#12316)
- fix(feedback): Wait for document to be ready before doing autoinject (#12294)
- fix(nextjs): Fix memory leak (#12335)
- fix(nextjs): Fix version detection and option insertion logic for
clientTraceMetadata
option (#12323) - fix(nextjs): Update argument name in log message about
sentry
property on Next.js config object (#12366) - fix(node): Do not manually finish / update root Hapi spans. (#12287)
- fix(node): Fix virtual parent span ID handling & update create-next-app E2E test (#12368)
- fix(node): Skip capturing Hapi Boom responses v8. (#12288)
- fix(performance): Fix LCP not getting picked up on initial pageload transaction by setting reportAllChanges to true
(#12360)
- fix(replay): Avoid infinite loop of logs (#12309)
- fix(replay): Ignore old events when manually starting replay (#12349)
- ref(browser): Ensure idle span ending is consistent (#12310)
- ref(profiling): unref timer (#12340)
Work in this release contributed by @dohooo, @mohd-akram, and @ykzts. Thank you for your contributions!