@sentry/node

Sentry Node SDK using OpenTelemetry for performance instrumentation

Last updated 10 days ago by sentry-bot .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ npm install @sentry/node

SYNC missed versions from official npm registry.

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

Current Tags

8.37.1 ... latest (9 days ago)
8.36.0-alpha.1 ... next (21 days ago)
7.119.2 ... v7 (a month ago)

532 Versions

Maintainers (11)

Downloads

Total 0

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 0

Dependencies (35)

@sentry/core 8.37.0
@sentry/types 8.37.0
@sentry/utils 8.37.0
@opentelemetry/api ^1.9.0
@opentelemetry/core ^1.25.1
import-in-the-middle ^1.11.2
@sentry/opentelemetry 8.37.0
@prisma/instrumentation 5.19.1
@opentelemetry/resources ^1.26.0
@opentelemetry/sdk-trace-base ^1.26.0
@opentelemetry/instrumentation ^0.54.0
@opentelemetry/instrumentation-fs 0.16.0
@opentelemetry/instrumentation-pg 0.44.0
@opentelemetry/context-async-hooks ^1.25.1
@opentelemetry/instrumentation-koa 0.43.0
@opentelemetry/instrumentation-hapi 0.41.0
@opentelemetry/instrumentation-http 0.53.0
@opentelemetry/semantic-conventions ^1.27.0
@opentelemetry/instrumentation-mysql 0.41.0
@opentelemetry/instrumentation-mysql2 0.41.0
@opentelemetry/instrumentation-undici 0.6.0
@opentelemetry/instrumentation-amqplib ^0.42.0
@opentelemetry/instrumentation-connect 0.40.0
@opentelemetry/instrumentation-express 0.44.0
@opentelemetry/instrumentation-fastify 0.41.0
@opentelemetry/instrumentation-graphql 0.44.0
@opentelemetry/instrumentation-ioredis 0.43.0
@opentelemetry/instrumentation-kafkajs 0.4.0
@opentelemetry/instrumentation-mongodb 0.48.0
@opentelemetry/instrumentation-redis-4 0.42.0
@opentelemetry/instrumentation-mongoose 0.42.0
@opentelemetry/instrumentation-dataloader 0.12.0
@opentelemetry/instrumentation-nestjs-core 0.40.0
@opentelemetry/instrumentation-generic-pool 0.39.0
@opentelemetry/instrumentation-lru-memoizer 0.40.0

Dev Dependencies (1)

@types/node ^14.18.0

Dependents (2)

© 2010 - cnpmjs.org x YWFE | Home | YWFE