JavaScript

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/browser @sentry/tracing
# Using npm
npm install --save @sentry/browser @sentry/tracing

Configure

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

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

Copied
import * as Sentry from "@sentry/browser";
import { Integrations } from "@sentry/tracing";

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

  // To set your release version
  release: "my-project-name@" + process.env.npm_package_version,
  integrations: [new Integrations.BrowserTracing()],

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production
  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
myUndefinedFunction();

Or, by manually generating an event:

In JavaScript 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 traceback can be recorded.

Copied
try {
  aFunctionThatMightFail();
} catch (err) {
  Sentry.captureException(err);
}

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.