Skip to content

README.md

Latest commit

 

History

History
66 lines (49 loc) · 2.13 KB

README.md

File metadata and controls

66 lines (49 loc) · 2.13 KB

Sentry

Official Sentry SDK for Node (EXPERIMENTAL)

npm version npm dm npm dt

This is a WIP, proof of concept implementation of a Node SDK that uses OpenTelemetry for performance instrumentation under the hood.

THIS MAY/WILL BREAK IN MANY UNEXPECTED WAYS. We may remove, add, change any of the integrations, add/remove any exports, etc. This package is NOT READY TO USE IN ANY FORM OF PRODUCTION ENVIRONMENT!

This SDK is considered experimental and in an alpha state. It may experience breaking changes, and may be discontinued at any time. Please reach out on GitHub if you have any feedback/concerns.

Installation

npm install @sentry/node-experimental

# Or yarn
yarn add @sentry/node-experimental

Usage

// ES5 Syntax
const Sentry = require('@sentry/node-experimental');
// ES6 Syntax
import * as Sentry from '@sentry/node-experimental';

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

Note that it is necessary to initialize Sentry before you import any package that may be instrumented by us.

Available (Performance) Integrations

  • Http
  • Express
  • Fastify
  • Nest
  • Mysql
  • Mysql2
  • GraphQL
  • Mongo
  • Mongoose
  • Postgres
  • Prisma

All of these are auto-discovered, you don't need to configure anything for performance. You still need to register middlewares etc. for error capturing. Other, non-performance integrations from @sentry/node are also available (except for Undici).

Links