Fastify+GraphQL API的OpenTelemetry追踪缺失全覆盖问题咨询

未追踪时长的核心可能来源 #

GraphQL查询执行完成后到响应返回客户端的阶段，大概率包含序列化和gzip压缩环节——当返回的GraphQL结果结构复杂、数据量较大时，这两个操作会消耗可观的CPU资源和时间，完全可能占据你看到的50%未追踪时长。除此之外，还可能存在这些未被覆盖的环节：

• Fastify onSend等响应钩子中的自定义业务逻辑
• 响应头、Cookie的批量设置操作
• 数据返回前的最后校验或格式转换步骤

如何为序列化与压缩环节添加OpenTelemetry追踪 #

Fastify的序列化和压缩逻辑可以通过手动创建Span实现精准追踪，以下是具体落地方式：

1. 追踪GraphQL结果序列化 #

如果是手动处理GraphQL结果序列化，直接在序列化前后插入Span：

const { trace } = require('@opentelemetry/api');

async function executeGraphQLQuery(query, context) {
  const tracer = trace.getTracer('api-graphql');
  // 执行查询（已有追踪）
  const result = await runQuery(query, context);
  
  // 创建序列化Span
  const serializeSpan = tracer.startSpan('graphql-serialize-result');
  try {
    const serializedResult = JSON.stringify(result);
    return serializedResult;
  } finally {
    serializeSpan.end();
  }
}

如果依赖Fastify自动序列化，用onSend钩子插入追踪：

fastify.addHook('onSend', async (request, reply, payload) => {
  const tracer = trace.getTracer('api-fastify');
  const serializeSpan = tracer.startSpan('fastify-serialize-response', {
    attributes: {
      'http.path': request.routeOptions.path,
      'graphql.operation.type': request.body?.operationName || 'unknown'
    }
  });
  
  try {
    return payload;
  } finally {
    serializeSpan.end();
  }
});

2. 追踪gzip压缩环节 #

如果使用@fastify/compress插件，通过自定义压缩逻辑包装追踪：

const compress = require('@fastify/compress');
const { trace } = require('@opentelemetry/api');

fastify.register(compress, {
  customCompress: async (request, reply, payload) => {
    const tracer = trace.getTracer('api-compress');
    const compressSpan = tracer.startSpan('response-gzip-compress', {
      attributes: {
        'http.accept-encoding': request.headers['accept-encoding'],
        'payload.size': Buffer.byteLength(payload)
      }
    });
    
    try {
      const compressed = await compress.defaultCompress(request, reply, payload);
      compressSpan.setAttribute('compressed.size', Buffer.byteLength(compressed));
      return compressed;
    } finally {
      compressSpan.end();
    }
  }
});

3. 补充完整链路追踪 #

还可以给Fastify响应生命周期的收尾节点加追踪，确认响应实际发送完成的时间：

fastify.addHook('onResponse', async (request, reply) => {
  const tracer = trace.getTracer('api-fastify');
  const responseSpan = tracer.startSpan('fastify-response-sent');
  responseSpan.setAttributes({
    'http.status_code': reply.statusCode,
    'http.response_time': reply.getResponseTime()
  });
  responseSpan.end();
});

验证方式 #

添加完追踪后重新发起请求，查看OpenTelemetry追踪图：

• 检查新增的graphql-serialize-result、response-gzip-compress等Span的时长占比
• 对比这些Span的总时长是否匹配之前未被追踪的50%区间
• 如果仍有剩余未追踪时长，进一步排查Fastify第三方插件的内部逻辑或隐性依赖调用

内容的提问来源于stack exchange，提问作者Peter Kusza