Node.js中使用OpenTelemetry Http Instrumentation无法捕获正确响应体

问题分析 #

你当前通过HttpInstrumentation的responseHook监听response对象的data事件捕获响应体，但得到的{"partialSuccess":{}}并非业务接口的实际响应——这是OpenTelemetry Trace Exporter发送数据到Collector的响应，而非你的Express服务返回的内容。

核心原因：

• 服务器端场景下，HttpInstrumentation的默认responseHook触发时机过晚，Express已经完成响应发送，response对象的data事件已执行完毕，你的监听器无法捕获到业务响应流。
• 误将Exporter自身的响应当成了业务接口的响应。

解决方案 #

方法1：通过Express中间件捕获响应体并关联OTel Span #

重写Express响应的send/json方法，在响应发送前捕获内容，再绑定到当前活跃的Span上：

// 在app.js中添加该中间件，需放在app.use(express.json())之后
const { trace } = require('@opentelemetry/api');

app.use((req, res, next) => {
  // 保存原生响应方法
  const originalSend = res.send;
  const originalJson = res.json;

  res.send = function(body) {
    const activeSpan = trace.getSpan(trace.context.active());
    if (activeSpan) {
      // 将响应体转为字符串后设置为Span属性
      const bodyStr = typeof body === 'object' ? JSON.stringify(body) : body;
      activeSpan.setAttribute('http.response.body', bodyStr);
    }
    return originalSend.call(this, body);
  };

  res.json = function(body) {
    const activeSpan = trace.getSpan(trace.context.active());
    if (activeSpan) {
      activeSpan.setAttribute('http.response.body', JSON.stringify(body));
    }
    return originalJson.call(this, body);
  };

  next();
});

方法2：调整HttpInstrumentation配置，针对服务器端响应监听 #

修改tracing.js中的HttpInstrumentation配置，使用服务器端专属的响应钩子（需确保OTel版本支持）：

new HttpInstrumentation({
  // 启用服务器端追踪
  enableServerInstrumentation: true,
  // 服务器端响应钩子，在响应发送前挂载监听
  serverResponseHook: (span, request, response) => {
    let responseChunks = [];
    // 监听响应流的data事件
    response.on('data', (chunk) => responseChunks.push(chunk));
    // 响应结束后拼接内容并设置到Span
    response.on('finish', () => {
      if (responseChunks.length > 0) {
        const bodyStr = Buffer.concat(responseChunks).toString();
        span.setAttribute('http.response.body', bodyStr);
      }
    });
  }
})

注意事项 #

• 若使用旧版OTel，可能没有serverResponseHook，需升级到最新稳定版。
• 生产环境中避免捕获大体积响应体，防止Span数据过大影响性能与存储。
• 确认OTel Collector配置正确，避免混淆业务响应与Exporter自身的响应。

内容的提问来源于stack exchange，提问作者Gaurav Mann