Node.js

On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.

Using a framework? Take a look at our specific guides to get started.

Install

Sentry captures data by using an SDK within your application’s runtime.

Copied
# Using yarn
yarn add @sentry/node @sentry/tracing
# Using npm
npm install --save @sentry/node @sentry/tracing

Configure

Configuration should happen as early as possible in your application's lifecycle.

Once this is done, Sentry's Node SDK captures all transactions and unhandled exceptions.

Copied
import * as Sentry from "@sentry/node";
import * as Tracing from "@sentry/tracing";

Sentry.init({
    dsn: "https://examplePublicKey@o0.ingest.sentry.io/0" });

  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,
});

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:

Copied
const transaction = Sentry.startTransaction({
  op: "test",
  name: "My First Test Transaction",
});

setTimeout(() => {
  try {
    foo();
  } catch (e) {
    Sentry.captureException(e);
  } finally {
    transaction.finish();
  }
}, 99);

Or, by manually generating an event:

You can pass an error object to captureException() to get it captured as event. It's possible to throw strings as errors in which case no stacktrace can be recorded.

Copied
try {
  // ...
} catch (e) {
  Sentry.captureException(e);
}

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.

You can edit this page on GitHub.