Bun

Prerequisites

You need:

• A Sentry account and project
• Your application up and running

Install

In addition to capturing errors, you can monitor interactions between multiple services or applications by enabling tracing.

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

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

bun add @sentry/bun

Configure

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:

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",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/bun/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  //  performance

  // Add Performance Monitoring by setting tracesSampleRate
  // Set tracesSampleRate to 1.0 to capture 100% of transactions
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  //  performance
});

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.

Add Readable Stack Traces to Errors

Depending on how you've set up your project, the stack traces in your Sentry errors probably won't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

• Logging into Sentry and selecting a project
• Installing the necessary Sentry packages
• Configuring your build tool to generate and upload source maps
• Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

Use

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:

// Import this first!
import "./instrument";

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

// Your application code goes here

Verify

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

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

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