Node.js
Sentry's Node SDK enables automatic reporting of errors, exceptions, and transactions.
Our Node SDK supports all recent versions, and integrates well with a variety of popular frameworks and packages. It gives developers the ability to see Node source code at each frame instead and get proper asynchronous context tracking in a way that fits Node’s concurrency model.
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.
If you don't already have an account and Sentry project established, head over to sentry.io, then return to this page.
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.
# 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.
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:
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.
try {
// ...
} catch (e) {
Sentry.captureException(e);
}
Learn more about manually capturing an error or message, in our Usage documentation.
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.
- Package:
- npm:@sentry/node
- Version:
- 6.0.2
- Repository:
- https://github.com/getsentry/sentry-javascript