OpenNext项目中的OpenTelemetry支持问题解析

背景介绍

OpenNext作为Next.js应用的部署适配器，在支持OpenTelemetry(简称Otel)方面遇到了挑战。OpenTelemetry作为云原生时代可观测性的重要标准，在现代Web应用开发中扮演着关键角色。本文将深入分析OpenNext项目中OpenTelemetry支持的问题及其解决方案。

问题本质

OpenNext在本地开发环境(SST)中可以正常使用OpenTelemetry，但在远程部署后却无法正常工作。这个问题表现为：

1. 本地开发环境(SST)下OpenTelemetry工作正常
2. 部署到生产环境后OpenTelemetry完全失效
3. 相同代码在其他平台(Vercel、Railway、AWS ECS/ECR)上部署却能正常工作

技术原因分析

经过深入调查，发现问题根源在于Next.js的OpenTelemetry实现依赖于Vercel特有的请求上下文机制。具体来说：

1. Next.js的OpenTelemetry实现会查找名为@vercel/request-context的Symbol
2. 该上下文提供了waitUntil方法用于异步操作，以及请求头和URL信息
3. OpenNext默认不提供这个Vercel特有的上下文环境

解决方案

OpenNext团队提供了两种解决方案：

方案一：自定义包装器

通过创建自定义包装器来模拟Vercel的请求上下文：

// customWrapper.ts
import streamingWrapper from 'open-next/wrappers/aws-lambda.js'
import {WrapperHandler} from 'open-next/types/open-next.js'

const handler : WrapperHandler = async (handler, converter) => {
  const defaultHandler = await streamingWrapper.wrapper(handler, converter)
  return async (event, context) => {
    const symbol = Symbol.for("@vercel/request-context");
    const promiseToAwaits : Promise<unknown>[] = []

    globalThis[symbol] = {
      get: () => {
        return {
          waitUntil: (promiseOrFunc) => {
            const promise = 'then' in promiseOrFunc ? promiseOrFunc : promiseOrFunc()
            promiseToAwaits.push(promise)
          },
          headers: event.headers,
          url: event.rawPath,
        }
      }
    }
    const response = await defaultHandler(event, context)
    await Promise.all(promiseToAwaits)
    return response
  }
}

方案二：官方修复

OpenNext团队在后续版本中通过PR #784正式修复了这个问题。用户只需升级到最新版本即可获得原生支持。

实施建议

对于需要使用OpenTelemetry的生产环境：

1. 优先考虑升级到已修复该问题的OpenNext版本
2. 如需立即解决，可使用自定义包装器方案，但需注意：
   • 此方案依赖Vercel内部实现细节，可能有兼容性风险
   • 需要自行处理异步操作的等待逻辑
3. 在生产环境充分测试OpenTelemetry功能

总结

OpenNext项目对OpenTelemetry的支持经历了从有问题到完善的过程。这反映了开源项目在适配不同平台特性时的挑战。通过理解问题本质和技术细节，开发者可以更好地在OpenNext环境中实现完整的可观测性方案。