Cloudflare Instrumentation for Queues seems broken

[arthurfiorette]

Hey @JPeer264 @logaretm is this working? Latest docs says to manually instrument and i couldn't get automated instrumentation to work.

https://docs.sentry.io/platforms/javascript/guides/cloudflare/tracing/instrumentation/queues-module/

Originally posted by @arthurfiorette in #20529 (comment)

[linear-code]

JS-3056

[arthurfiorette]

Sorry if this crosspost is not the right place to ask but I opened it here so that message wouldn't get lost.

[sentry-pierre]

The SDK does automatically instrument queue consumers and producers for Cloudflare Workers when you use withSentry (consumer handlers) and the instrumented env object (producer bindings). The docs page you linked only covers manual spans, which is likely why it feels like automatic instrumentation is missing.

To help figure out why it isn't working for you, could you share:

• The version of @sentry/cloudflare you're using.
• A minimal snippet of how you're exporting your handler and initializing Sentry.
• What you're observing instead of the expected spans (e.g., no queue spans, missing attributes, errors in the console).

A maintainer can take a closer look once there's a repro.

[arthurfiorette]

Maybe this is a docs mismatch then? Documentation states that I need to manually instrument queues and crons .

Do I need to intentionally skip fetch instrumentation because when the app is hono it should be a plugin? Hono+Cloudflare docs have nothing about it.

Do I need to do something like:

app.use('*', sentry(env => createOps(env)));

export default {
  fetch: app.fetch,
   ...withSentry(env => createOps(env), { scheduled, queue })
 }

so withSentry doesnt instrument fetch natively and waits for hono specific plugin?

[JPeer264]

Hey @arthurfiorette thanks for the issue.

pierre is right, queues are automatically instrumented with the latest version of the SDK. But only if you have them listed as bindings in your wrangler.jsonc

The setup for Hono+Cloudflare is listed here: https://docs.sentry.io/platforms/javascript/guides/hono/

import { Hono } from "hono";
import { sentry } from "@sentry/hono/cloudflare";

const app = new Hono();

app.use(
  sentry(app, {
    dsn: "<YOUR_DSN>",
    dataCollection: {
      // To disable sending user data and HTTP bodies, uncomment the lines below. For more info visit:
      // https://docs.sentry.io/platforms/javascript/guides/hono/configuration/options/#dataCollection
      // userInfo: false,
      // httpBodies: [],
    },
  }),
);

// Your routes here

export default app;

I will also update the docs to make it a little bit clearer; as queues in general are kinda different to Cloudflare Queues as product.

[arthurfiorette]

Btw @JPeer264, I believe at packages/cloudflare/src/instrumentations/worker/instrumentQueueProducer.ts getTraceData() should be appended to each json message so the consumer can continue and create a distributed trace and not just produce queue spans separately.