Sentry for Bun
Learn how to manually set up Sentry in your Bun app and capture your first events.
You need:
Use the Bun package manager to add the Sentry SDK to your application:
bun add @sentry/bun
bun add @sentry/bun
Error Monitoring starts working as soon as you call Sentry.init(). Logs and Application Metrics need no extra configuration, and you'll learn how to send them in steps #3 and #4. This guide also enables Tracing.
Sentry should be initialized as early in your app as possible. Create a file named instrument.js in the root directory of your project and add the code snippet shown below.
The snippet also turns on:
- Tracing: via
tracesSampleRate
Don't need a feature? Remove its integration and options from the snippet.
instrument.jsimport * as Sentry from "@sentry/bun";
// Ensure to call this before importing any other modules!
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
});
import * as Sentry from "@sentry/bun";
// Ensure to call this before importing any other modules!
Sentry.init({
dsn: "___PUBLIC_DSN___",
// Enables Tracing.
// Set to 1.0 to capture 100% of spans for tracing.
// We recommend reducing this value in production.
tracesSampleRate: 1.0,
});
We recommend building with the Sentry plugin, because it adds spans from your dependencies, such as database drivers, AI SDKs, and web frameworks like Express, Koa and Hapi. Bun has no runtime hook Sentry can use to instrument those packages, so the plugin rewrites them as bun build bundles them.
Add sentryBunPlugin from @sentry/bun/plugin to your Bun.build() call, then run the output the same way, with --preload. Errors, the spans you create yourself, and Bun.serve, node:http and fetch spans work either way.
build.tsimport { sentryBunPlugin } from "@sentry/bun/plugin";
await Bun.build({
entrypoints: ["./app.ts"],
outdir: "./dist",
target: "bun",
plugins: [sentryBunPlugin()],
});
import { sentryBunPlugin } from "@sentry/bun/plugin";
await Bun.build({
entrypoints: ["./app.ts"],
outdir: "./dist",
target: "bun",
plugins: [sentryBunPlugin()],
});
Preload your instrumentation file with the --preload flag. This is what guarantees that Sentry.init() runs before any other module is loaded.
bun --preload ./instrument.js app.js
bun --preload ./instrument.js app.js
bun --preload ./instrument.js dist/app.js
The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard.
Alternatively, take a look at our Uploading Source Maps documentation.
npx @sentry/wizard@latest -i sourcemaps
npx @sentry/wizard@latest -i sourcemaps
By default, the SDK sends user identity data (IP address, ID, and similar) and other data like HTTP bodies and URL query parameters. This will give you rich debugging context.
The SDK always filters sensitive values whose keys match a built-in denylist, such as auth or password, and sends [Filtered] instead.
To send less data, turn off the categories you don't need in the dataCollection option. For the full list of categories and their defaults, see the dataCollection options.
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Sentry.init({
dsn: "___PUBLIC_DSN___",
dataCollection: {
userInfo: false,
// other categories
},
});
Use Sentry.logger to send logs at different levels, such as info, warn, or error. You can pass any attributes you want and search or filter by them later. See Set Up Logs for all available logging methods and the syntax for formatting messages.
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
Sentry.logger.info("User example action completed");
Sentry.logger.warn("Slow operation detected", {
operation: "data_fetch",
duration: 3500,
});
Sentry.logger.error("Validation failed", {
form_field: "email",
reason: "Invalid email",
});
If you're already logging with another library, use an integration to capture those logs as Sentry Logs automatically:
consoleLoggingIntegrationforconsolecalls- Consola
- Pino
Use Sentry.metrics to send counters, gauges, and distributions from your app to Sentry. You can pass any attributes you want and search or filter by them later. See Set Up Metrics for all available metric types and configuration options.
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
Sentry.metrics.count("checkout.failed", 1);
Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });
Sentry.metrics.distribution("api_latency", 187, {
unit: "millisecond",
attributes: { endpoint: "/api/orders" },
});
For Bun, bunRuntimeMetricsIntegration also collects runtime health metrics automatically.
Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.
Add an intentional error to your main application file:
setTimeout(() => {
throw new Error("Sentry Test Error");
}, 0);
setTimeout(() => {
throw new Error("Sentry Test Error");
}, 0);
Finally, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).
At this point, you should have integrated Sentry into your Bun application. Here's what to explore next:
- Explore practical guides on what to monitor, log, track, and investigate after setup
- Set up Agent Tracing to monitor your AI systems
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").