OpenTelemetry-JS中如何为Fetch请求添加自定义Span属性

在OpenTelemetry-JS的实践中，开发者经常需要监控前端应用的网络请求行为。当使用浏览器原生的Fetch API时，OpenTelemetry会自动创建对应的Span记录请求过程，但有时我们需要在这些Span中添加业务相关的自定义属性（例如GraphQL查询语句）。

核心问题分析

默认情况下，Fetch请求的Span会在HTTP请求完成时立即结束（遵循HTTP语义约定）。这意味着在常见的异步处理模式中：

const res = await fetch(url);  // Span在此阶段已结束
processResponse(res);          // 此时已无法修改Span属性

这种设计符合OpenTelemetry的语义规范，因为HTTP Span应该只包含协议层面的信息（如状态码、请求方法等），而业务逻辑数据更适合放在自定义Span中。

解决方案

方案一：使用Fetch插件的自定义属性回调

OpenTelemetry-JS的@opentelemetry/instrumentation-fetch插件提供了applyCustomAttributesOnSpan配置项：

import { FetchInstrumentation } from '@opentelemetry/instrumentation-fetch';

new FetchInstrumentation({
  applyCustomAttributesOnSpan: (span, request, response) => {
    if (request.method === 'POST' && request.url.includes('/graphql')) {
      const body = JSON.parse(request.body?.toString() || '{}');
      span.setAttribute('graphql.query', body.query);
    }
  }
});

注意事项：

• 回调执行时请求体可能尚未完全加载
• 需要处理可能的异常情况（如非JSON请求体）
• 建议只添加与协议相关的扩展属性

方案二：创建业务层Span（推荐）

更符合OpenTelemetry设计理念的做法是创建独立的业务Span：

const tracer = trace.getTracer('graphql-client');

async function queryGraphQL(query) {
  return tracer.startActiveSpan('graphql.query', async (span) => {
    try {
      span.setAttribute('graphql.query', query);
      const res = await fetch(GRAPHQL_URL, {
        method: 'POST',
        body: JSON.stringify({ query })
      });
      // 可以关联HTTP Span和业务Span
      const otelContext = propagation.extract(context.active(), res.headers);
      context.with(otelContext, () => { /* ... */ });
      return await res.json();
    } finally {
      span.end();
    }
  });
}

这种方式的优势：

• 明确分离协议层和业务层监控
• 支持更复杂的业务属性记录
• 可以建立Span之间的父子关系
• 避免污染标准HTTP语义属性

最佳实践建议

1. 分层监控：基础设施层（HTTP）和业务层分开监控
2. 属性命名规范：自定义属性建议使用业务域前缀（如graphql.）
3. 性能考量：避免在Span中记录过大文本（如完整响应体）
4. 错误处理：确保Span在任何情况下都能正确结束

通过合理设计监控点，开发者既能获得OpenTelemetry标准化的协议层监控，又能灵活记录业务关键信息，构建完整的应用可观测性体系。