Socket
Socket
Sign inDemoInstall

@sentry/node

Package Overview
Dependencies
103
Maintainers
11
Versions
496
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @sentry/node

Sentry Node SDK using OpenTelemetry for performance instrumentation


Version published
Weekly downloads
5.9M
increased by4.76%
Maintainers
11
Created
Weekly downloads
 

Package description

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

Changelog

Source

8.0.0-alpha.7

This is the seventh alpha release of Sentry JavaScript SDK v8, 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.

Important Changes

  • feat(nextjs): Use OpenTelemetry for performance monitoring and tracing (#11016)

We now use OpenTelemetry under the hood to power performance monitoring and tracing in the Next.js SDK.

  • feat(v8/gatsby): Update SDK initialization for gatsby (#11292)

In v8, you cannot initialize the SDK anymore via Gatsby plugin options. Instead, you have to configure the SDK in a sentry.config.js file.

We also removed the automatic initialization of browserTracingIntegration. You now have to add this integration yourself.

Removal/Refactoring of deprecated functionality

  • feat(v8): Remove addGlobalEventProcessor (#11255)
  • feat(v8): Remove deprecated span id fields (#11180)
  • feat(v8): Remove makeMain export (#11278)
  • feat(v8/core): Remove deprecated span.sampled (#11274)
  • feat(v8/core): Remove getActiveTransaction (#11280)
  • feat(v8/core): Remove spanMetadata field (#11271)
  • feat(v8/ember): Remove deprecated StartTransactionFunction (#11270)
  • feat(v8/replay): Remove deprecated replay options (#11268)
  • feat(v8/svelte): Remove deprecated componentTrackingPreprocessor export (#11277)
  • ref: Remove more usages of getCurrentHub in the codebase (#11281)
  • ref(core): Remove scope.setSpan() and scope.getSpan() methods (#11051)
  • ref(profiling-node): Remove usage of getCurrentHub (#11275)
  • ref(v8): change integration.setupOnce signature (#11238)
  • ref: remove node-experimental references (#11290)

Other Changes

  • feat(feedback): Make "required" text for input elements configurable (#11152) (#11153)
  • feat(feedback): Update user feedback screenshot and cropping to align with designs (#11227)
  • feat(nextjs): Remove runtime and vercel tags (#11291)
  • feat(node): Add scope to ANR events (#11256)
  • feat(node): Do not include prismaIntegration by default (#11265)
  • feat(node): Ensure tracePropagationTargets are respected (#11285)
  • feat(node): Simplify SentrySpanProcessor (#11273)
  • feat(profiling): Use OTEL powered node package (#11239)
  • feat(utils): Allow text encoder/decoder polyfill from global SENTRY (#11283)
  • fix(nextjs): Show misconfiguration warning (no instrumentation.ts) (#11266)
  • fix(node): Add logs when node-fetch cannot be instrumented (#11289)
  • fix(node): Skip capturing Hapi Boom error responses. (#11151)
  • fix(node): Use suppressTracing to avoid capturing otel spans (#11288)
  • fix(opentelemetry): Do not stomp span status when startSpan callback throws (#11170)

Readme

Source

Sentry

Official Sentry SDK for Node

npm version npm dm npm dt

Installation

npm install @sentry/node

# Or yarn
yarn add @sentry/node

Usage

// 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.

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.

FAQs

Last updated on 27 Mar 2024

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc