@sentry/bun not reporting any span data

[nzapponi]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/bun

SDK Version

8.13.0

Framework Version

No response

Link to Sentry event

No response

SDK Setup/Reproduction Example

Entrypoint line 1:

import "./sentry.ts"

sentry.ts

import { SocketIoInstrumentation } from "@opentelemetry/instrumentation-socket.io";
import * as Sentry from "@sentry/bun";
import data from "../../../package.json";
import { SENTRY_DSN, SENTRY_ENVIRONMENT } from "./const";

Sentry.init({
  dsn: SENTRY_DSN,
  tracesSampleRate: 1.0,
  environment: SENTRY_ENVIRONMENT,
  release: data.version,
});

Sentry.addOpenTelemetryInstrumentation(new SocketIoInstrumentation());

Steps to Reproduce

1. Start the bun server (which uses Express)
2. Make an API call from the client (or curl) to the server

Expected Result

A trace of the API call from request to response, including all the middleware calls, database queries (I'm using pg), etc.

Actual Result

I get a trace, but every transaction just says "Empty - Transaction did not report any span data"
This also happens on server-side events that I instrumented using await Sentry.startSpan(...): I get a trace that the span is there, but no data within it.

[andreiborza]

Hi, thank you for reporting this. Could you please add debug: true to your sentry options and paste some output?

[nzapponi]

Thanks @andreiborza !

Here it is:

$ bun run --hot src/server.ts
Sentry Logger [log]: Initializing Sentry: process: 72557, thread: main.
Sentry Logger [log]: Integration installed: InboundFilters
Sentry Logger [log]: Integration installed: FunctionToString
Sentry Logger [log]: Integration installed: LinkedErrors
Sentry Logger [log]: Integration installed: RequestData
Sentry Logger [log]: Integration installed: Console
Sentry Logger [log]: Integration installed: Http
Sentry Logger [log]: Integration installed: NodeFetch
Sentry Logger [log]: Integration installed: OnUncaughtException
Sentry Logger [log]: Integration installed: OnUnhandledRejection
Sentry Logger [log]: Integration installed: ContextLines
Sentry Logger [log]: Integration installed: Context
Sentry Logger [log]: Integration installed: Modules
Sentry Logger [log]: Integration installed: BunServer
Sentry Logger [log]: Running in CommonJS mode.
Sentry Logger [debug]: @opentelemetry/api: Registered a global for diag v1.9.0.
Sentry Logger [debug]: @opentelemetry/api: Registered a global for trace v1.9.0.
Sentry Logger [debug]: @opentelemetry/api: Registered a global for context v1.9.0.
Sentry Logger [debug]: @opentelemetry/api: Registered a global for propagation v1.9.0.
Sentry Logger [warn]: @opentelemetry/instrumentation-socket.io Module socket.io has been loaded before @opentelemetry/instrumentation-socket.io so it might not work, please initialize it before requiring socket.io
Sentry Logger [warn]: @opentelemetry/instrumentation-socket.io Module socket.io has been loaded before @opentelemetry/instrumentation-socket.io so it might not work, please initialize it before requiring socket.io
  server:app Registered data model +0ms
[Sentry] express is not instrumented. This is likely because you required/imported express before calling `Sentry.init()`.
  server:app Bootstrapping services +0ms
  server:pg Initializing database +0ms
  server:pg Running migrations +0ms
  server:app Listening on port 28001... +0ms

[nzapponi]

Weird that it says Running in CommonJS mode... isn't it?

[lforst]

@nzapponi The logic for that log message basically just checks whether require is in the global namespace. This is a bit weird in bun, because it maximizes compatibility.

Could you provide a reproduction of where this is not working? Thanks! It's a bit hard to gauge things from looking afar.

[nzapponi]

Here is a sample repo to reproduce: https://github.com/nzapponi/bun-sentry-repro
I keep getting no span data.

Thanks!

[chargome]

Thank you @nzapponi, we'll look into it!

[chargome]

@nzapponi it seems that there are issues regarding the auto-instrumentation with express and bun.

I keep getting no span data.

For now, although you do not receive auto-generated span data you can still make use of custom instrumentation and error monitoring for your app with your current setup.

We'll reference this issue once we have a fix.

[nzapponi]

Ok thanks

[nzapponi]

Solved by replacing Sentry.setupExpressErrorHandler(app) with app.use(Sentry.expressErrorHandler())

[chargome]

Hmm strange, we basically do the same thing within setupExpressErrorHandler:

export function setupExpressErrorHandler(
  app: { use: (middleware: ExpressMiddleware | ExpressErrorMiddleware) => unknown },
  options?: ExpressHandlerOptions,
): void {
  app.use(expressRequestHandler());
  app.use(expressErrorHandler(options));
  ensureIsWrapped(app.use, 'express');
}

Thanks for sharing your findings @nzapponi !

[nzapponi]

Weird!

Given that, it feels like I should also add the expressRequestHandler.

And shouldn't that be called before any routes and not after (like it is with your current implementation)? The way you implemented looks odd because any successful request will never hit the request handler.

Finally, I guess I may be wrong and it's not working any differently - the reason why I'm not seeing the warning anymore is likely because ensureIsWrapped is not being called anymore.

I'll do more digging and report back.

[chargome]

What does ensureIsWrapped do?

This just checks if express is properly wrapped and emits a warning if not.

Given that, it feels like I should also add the expressRequestHandler then?

Yes I would say so.

Yes I think this is likely a timing/esm problem, but there are still issues with bun and preloading the instrumentation: oven-sh/bun#13165

[nzapponi]

Sorry, I just updated my comment above.

[nzapponi]

Alright, so here's how I fixed it actually - I went back to using Sentry.setupExpressErrorHandler(app) as my suggestion above was just hiding the console.log and not actually solving anything.

To get Express to work with Bun, I had to manually enable the Express integration during Sentry.init:

Sentry.init({
    dsn,
    tracesSampleRate: 1.0,
    integrations: [Sentry.expressIntegration()],
  });

I can now see the full Express data!
Tested with Bun v1.1.43.

[mydea]

Huh, that is a good point - we actually do not add any node performance integrations by default in bun. I wonder if we should do that 🤔

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #15586, which was included in the 9.5.0 release.