Sentry问题：迭代器异常未展示Body与Headers参数排查

问题翻译 #

我正在用Sentry追踪应用代码并查看错误列表，这个应用包含一个后端服务和两个不同的迭代器组件。三者的Sentry配置除DSN值外完全一致，但后端的异常能显示Body和Headers参数，迭代器的异常却无法展示这些参数。后端会调用这两个迭代器，请问这是什么原因？我哪里配置出错了？

补充说明I：
我的index.js中添加的代码如下：

import * as Sentry from "@sentry/node";
import * as Tracing from "@sentry/tracing";

Sentry.init({
    dsn: config.sentry_dsn,
    integrations: [
        // enable HTTP calls tracing
        new Sentry.Integrations.Http({ tracing: true }),
        // enable Express.js middleware tracing
        new Tracing.Integrations.Express({
        // to trace all requests to the default router
        app,
        // alternatively, you can specify the routes you want to trace:
        // router: someRouter,
        }),
    ],
    environment: config.node_env,
    // We recommend adjusting this value in production, or using tracesSampler
    // for finer control
    tracesSampleRate: 1.0,
});

// RequestHandler creates a separate execution context using domains, so that every
// transaction/span/breadcrumb is attached to its own Hub instance
app.use(Sentry.Handlers.requestHandler());
// TracingHandler creates a trace for every incoming request
app.use(Sentry.Handlers.tracingHandler());

app.use(Sentry.Handlers.errorHandler());

核心原因 #

后端能捕获Body和Headers，完全依赖于Express的requestHandler中间件——它会自动把当前HTTP请求的上下文（包括Body、Headers）附加到Sentry异常事件中。而迭代器组件出现问题，通常是以下两种场景导致：

1. 迭代器是非HTTP触发的任务（后台/异步逻辑） #

如果迭代器是后端调用的异步任务、定时任务或子进程逻辑，它不会经过Express的requestHandler中间件，自然没有请求上下文可以捕获。Sentry的上下文是绑定到执行环境的，迭代器的独立执行进程/线程不会自动继承后端的请求信息。

2. 迭代器是HTTP服务但配置有误 #

如果迭代器是独立的Express服务，可能存在以下配置问题：

• requestHandler挂载顺序错误：必须在所有路由和业务中间件之前挂载，否则无法捕获请求上下文
• 缺少Body解析中间件：如果没提前挂载express.json()/body-parser，requestHandler无法获取解析后的Body
• 显式关闭了Body/Headers捕获：requestHandler的配置项可能被设置为不捕获这些字段

针对性解决方案 #

场景一：迭代器是非HTTP任务 #

在后端调用迭代器时，手动传递请求的Body和Headers，并在迭代器中主动添加到Sentry上下文：

// 后端调用迭代器的代码
const requestBody = req.body;
const requestHeaders = req.headers;
// 将上下文参数传入迭代器
runIterator(requestBody, requestHeaders);

// 迭代器内部逻辑
function runIterator(body, headers) {
  // 手动把请求上下文附加到Sentry
  Sentry.configureScope(scope => {
    scope.setContext('request', {
      body: body,
      headers: headers
    });
  });
  // 迭代器的业务代码
}

如果迭代器在子进程中运行，需要通过进程间通信（如process.send）传递上下文信息，再在子进程的Sentry中设置。

场景二：迭代器是独立HTTP服务 #

修正迭代器的Express配置，确保requestHandler正确挂载：

// 迭代器的index.js
import * as Sentry from "@sentry/node";
import * as Tracing from "@sentry/tracing";
import express from 'express';

const app = express();

// 先挂载Body解析中间件，确保requestHandler能获取到解析后的Body
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

Sentry.init({
    dsn: 迭代器专属DSN,
    integrations: [
        new Sentry.Integrations.Http({ tracing: true }),
        new Tracing.Integrations.Express({ app }),
    ],
    environment: config.node_env,
    tracesSampleRate: 1.0,
});

// requestHandler必须在所有路由之前挂载
app.use(Sentry.Handlers.requestHandler({
  // 显式开启Body和Headers捕获（默认是开启的，可省略）
  request: {
    body: true,
    headers: true
  }
}));
app.use(Sentry.Handlers.tracingHandler());

// 挂载迭代器的路由
app.get('/your-iterator-route', (req, res) => { /* 业务逻辑 */ });

// 最后挂载错误处理中间件
app.use(Sentry.Handlers.errorHandler());

额外检查点 #

• 确认后端和迭代器的Sentry SDK版本一致：版本差异可能导致上下文捕获逻辑不兼容
• 检查迭代器的Sentry初始化配置：有没有误加request: { body: false }这类关闭捕获的配置

内容的提问来源于stack exchange，提问作者José Carlos