@sentry/node
Advanced tools
Sentry Node SDK using OpenTelemetry for performance instrumentation
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.
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');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 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 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.
npm install @sentry/node
# Or yarn
yarn add @sentry/node
// CJS Syntax
const Sentry = require('@sentry/node');
// ESM Syntax
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.
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.
8.0.0-alpha.4
This is the fourth Alpha release of the v8 cycle, which includes a variety of breaking changes.
Read the in-depth migration guide to find out how to address any breaking changes in your code.
The minimum Node version required for the SDK is now 14.18.0.
@sentry/google-cloud-serverless (#11065)@sentry/serverless is no longer published, and is replaced by two new packages: @sentry/google-cloud-serverless and
@sentry/aws-serverless. These packages are now the recommended way to instrument serverless functions. See the
migration guide for more details.
The Browser SDK and CDN bundles now emits ES2017 compatible code and drops support for IE11. This also means that the
Browser SDKs (@sentry/browser, @sentry/react, @sentry/vue, etc.) requires the fetch API to be available in the
environment. If you need to support older browsers, please transpile your code to ES5 using babel or similar and add
required polyfills.
New minimum supported browsers:
startTransaction export (#11015)unmask and unblock (#11049)replaySession and errorSampleRates (#11045)spanRecorder and all related code (#10977)origin field on span start options (#11058)startSpan options (#11054)startTransaction & finishTransaction hooks (#11008)sentry field in Next.js config as a means of configuration (#10839)startChild deprecations (#10956)getRootSpan() does not rely on transaction (#10979)getSpanDescendants() everywhere (#10924)transactionName when route is resolved (#11043)name parameter (#11057)@sentry/astro to use OpenTelemetry (#10960)HttpContext integration class (#10987)scope.transactionName from root spans (#10991)startIdleSpan (#10934)__SENTRY__ singleton (#11034)__SENTRY__ (#11074)continueTrace to be callback-only (#11044)spanToJSON to handle OTEL spans (#10922)tunnelRoute option (#10959)setupFastifyErrorHandler utility (#11061)getRootSpan functionality (#11004)transactionName in React Router instrumentations (#11048)unstable_sentryVitePluginOptions for full Vite plugin customization (#10930)createReduxEnhancer on server (#11005)handled value in ErrorBoundary depending on fallback (#10989)addScopeListener to Scope interface (#10952)AttachmentType and use for envelope attachment_type property (#10946)allowSyntheticDefaultImports (#11073)startChild (#11056)scope.transactionName on pageload and navigation span creation (#10992)startChild() (#11047)http & undici (#11055)Work in this release contributed by @MFoster and @jessezhang91. Thank you for your contributions!
FAQs
Sentry Node SDK using OpenTelemetry for performance instrumentation
The npm package @sentry/node receives a total of 1,624,817 weekly downloads. As such, @sentry/node popularity was classified as popular.
We found that @sentry/node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.