Bun

We have recently released v8 of the JavaScript SDKs. If you're using version 7.x, we recommend upgrading to the latest version. Check out the Migration docs to learn how to update your code to be compatible with v8.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

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

Copied
bun add @sentry/bun

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

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.

Once this is done, Sentry's Bun SDK captures unhandled exceptions as well as tracing data for your application.

You need to create a file named instrument.js that imports and initializes Sentry:

instrument.js
Copied
import * as Sentry from "@sentry/bun";

// Ensure to call this before importing any other modules!
Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  
  // Add Performance Monitoring by setting tracesSampleRate
  // Set tracesSampleRate to 1.0 to capture 100% of transactions
  // We recommend adjusting this value in production
  tracesSampleRate: 1.0,
});

Once you set a tracesSampleRate, performance instrumentation is automatically enabled for you. See Automatic Instrumentation to learn about all the things that the SDK automatically instruments for you.

You can also manually capture performance data - see Custom Instrumentation for details.

You need to 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:

app.js
Copied
// Import this first!
import "./instrument";

// Now import other modules
import http from "http";

// Your application code goes here

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

Copied
Sentry.startSpan({
  op: "test",
  name: "My First Test Transaction",
}, () => {
  setTimeout(() => {
    try {
      foo();
    } catch (e) {
      Sentry.captureException(e);
    }
  }, 99);
});

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.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").