如何使用 OpenTelemetry 设置仪器

可观察性对于理解和优化 Next.js 应用程序的行为和性能至关重要。

随着应用程序变得越来越复杂，识别和诊断可能出现的问题变得越来越困难。通过利用可观察性工具（例如日志记录和指标），开发人员可以深入了解其应用程序的行为，并确定优化的区域。借助可观察性，开发人员可以主动解决问题，以防它们成为主要问题，并提供更好的用户体验。因此，强烈建议在 Next.js 应用程序中使用可观察性，以提高性能，优化资源并增强用户体验。

我们建议使用 OpenTelemetry 来检测您的应用程序。它是一种平台无关的应用程序检测方式，允许您更改可观察性提供程序而无需更改代码。阅读官方 OpenTelemetry 文档以获取有关 OpenTelemetry 及其工作原理的更多信息。

本文档在整个文档中使用了“Span”、“Trace”或“Exporter”等术语，所有这些术语都可以在OpenTelemetry 可观察性入门中找到。

Next.js 开箱即用地支持 OpenTelemetry 仪器，这意味着我们已经对 Next.js 本身进行了仪器。

开始使用

OpenTelemetry 是可扩展的，但正确设置它可能会非常冗长。这就是为什么我们准备了一个包@vercel/otel来帮助您快速入门。

使用`@vercel/otel`

首先，安装以下包

npm install @vercel/otel @opentelemetry/sdk-logs @opentelemetry/api-logs @opentelemetry/instrumentation

接下来，在项目的**根目录**（如果使用 src 文件夹，则在 src 文件夹内）中创建自定义instrumentation.ts（或.js）文件

import { registerOTel } from '@vercel/otel'
 
export function register() {
  registerOTel({ serviceName: 'next-app' })
}

有关其他配置选项，请参阅@vercel/otel 文档。

须知:

instrumentation 文件应该位于项目的根目录，而不是 app 或 pages 目录中。如果您使用的是 src 文件夹，则将文件放在 src 文件夹中，与 pages 和 app 并列。

如果您使用 pageExtensions 配置选项添加后缀，您还需要更新 instrumentation 文件名以匹配。

我们创建了一个基本的with-opentelemetry示例供您使用。

手动 OpenTelemetry 配置

@vercel/otel 包提供了许多配置选项，应该可以满足大多数常见用例。但是，如果它不适合您的需求，您可以手动配置 OpenTelemetry。

首先，您需要安装 OpenTelemetry 包

npm install @opentelemetry/sdk-node @opentelemetry/resources @opentelemetry/semantic-conventions @opentelemetry/sdk-trace-node @opentelemetry/exporter-trace-otlp-http

现在您可以在instrumentation.ts中初始化NodeSDK。与@vercel/otel不同，NodeSDK与边缘运行时不兼容，因此您需要确保仅在process.env.NEXT_RUNTIME === 'nodejs'时导入它们。我们建议创建一个新文件instrumentation.node.ts，您只有在使用节点时才条件导入它。

export async function register() {
  if (process.env.NEXT_RUNTIME === 'nodejs') {
    await import('./instrumentation.node.ts')
  }
}

import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
import { resourceFromAttributes } from '@opentelemetry/resources'
import { NodeSDK } from '@opentelemetry/sdk-node'
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-node'
import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions'
 
const sdk = new NodeSDK({
  resource: resourceFromAttributes({
    [ATTR_SERVICE_NAME]: 'next-app',
  }),
  spanProcessor: new SimpleSpanProcessor(new OTLPTraceExporter()),
})
sdk.start()

这样做等同于使用@vercel/otel，但可以修改和扩展@vercel/otel未公开的一些功能。如果需要边缘运行时支持，则必须使用@vercel/otel。

测试你的仪器

您需要一个带有兼容后端 OpenTelemetry 收集器才能在本地测试 OpenTelemetry 跟踪。我们建议使用我们的OpenTelemetry 开发环境。

如果一切正常，您应该能够看到标记为GET /requested/pathname的根服务器 span。该特定跟踪中的所有其他 span 都将嵌套在其下。

Next.js 跟踪的 span 比默认发出的 span 多。要查看更多 span，您必须设置NEXT_OTEL_VERBOSE=1。

一旦您的收集器启动并运行，您就可以根据所选平台的部署指南将 Next.js 应用程序部署到其各自的平台。

自定义导出器

OpenTelemetry Collector 不是必需的。您可以使用自定义 OpenTelemetry 导出器与@vercel/otel或手动 OpenTelemetry 配置。

自定义 Span

您可以使用OpenTelemetry API添加自定义 span。

npm install @opentelemetry/api

以下示例演示了一个获取 GitHub 星级并添加自定义fetchGithubStarsspan 以跟踪获取请求结果的函数

import { trace } from '@opentelemetry/api'
 
export async function fetchGithubStars() {
  return await trace
    .getTracer('nextjs-example')
    .startActiveSpan('fetchGithubStars', async (span) => {
      try {
        return await getValue()
      } finally {
        span.end()
      }
    })
}

register 函数将在您的代码在新环境中运行之前执行。您可以开始创建新的 span，它们应该正确添加到导出的跟踪中。

Next.js 中的默认 Span

Next.js 会自动为您检测多个 span，以提供有关应用程序性能的有用见解。

span 上的属性遵循OpenTelemetry 语义约定。我们还在next命名空间下添加了一些自定义属性

next.span_name - 重复 span 名称
next.span_type - 每个 span 类型都有唯一的标识符
next.route - 请求的路由模式（例如，/[param]/user）。
next.rsc (true/false) - 请求是否为 RSC 请求，例如预取。
next.page
- 这是应用程序路由器使用的内部值。
- 您可以将其视为特殊文件的路由（例如page.ts、layout.ts、loading.ts等）
- 它只能与next.route配对时才能用作唯一标识符，因为/layout可用于标识/(groupA)/layout.ts和/(groupB)/layout.ts

`[http.method] [next.route]`

next.span_type: BaseServer.handleRequest

此 span 表示每个传入 Next.js 应用程序请求的根 span。它跟踪请求的 HTTP 方法、路由、目标和状态码。

属性

常见 HTTP 属性
- http.method
- http.status_code
服务器 HTTP 属性
- http.route
- http.target
next.span_name
next.span_type
next.route

`渲染路由（app） [next.route]`

next.span_type: AppRender.getBodyResult。

此 span 表示在应用程序路由器中渲染路由的过程。

属性

next.span_name
next.span_type
next.route

`fetch [http.method] [http.url]`

next.span_type: AppRender.fetch

此 span 表示在您的代码中执行的 fetch 请求。

属性

常见 HTTP 属性
- http.method
客户端 HTTP 属性
- http.url
- net.peer.name
- net.peer.port（仅当指定时）
next.span_name
next.span_type

通过在您的环境中设置NEXT_OTEL_FETCH_DISABLED=1可以关闭此 span。当您想使用自定义 fetch 仪器库时，这很有用。

`执行 API 路由（app） [next.route]`

next.span_type: AppRouteRouteHandlers.runHandler。

此 span 表示在应用程序路由器中执行 API 路由处理程序。

属性

next.span_name
next.span_type
next.route

`getServerSideProps [next.route]`

next.span_type: Render.getServerSideProps。

此 span 表示为特定路由执行getServerSideProps。

属性

next.span_name
next.span_type
next.route

`getStaticProps [next.route]`

next.span_type: Render.getStaticProps。

此 span 表示为特定路由执行getStaticProps。

属性

next.span_name
next.span_type
next.route

`渲染路由（pages） [next.route]`

next.span_type: Render.renderDocument。

此 span 表示为特定路由渲染文档的过程。

属性

next.span_name
next.span_type
next.route

`generateMetadata [next.page]`

next.span_type: ResolveMetadata.generateMetadata。

此 span 表示为特定页面生成元数据的过程（单个路由可以有多个此类 span）。

属性

next.span_name
next.span_type
next.page

`解析页面组件`

next.span_type: NextNodeServer.findPageComponents。

此 span 表示为特定页面解析页面组件的过程。

属性

next.span_name
next.span_type
next.route

`解析段模块`

next.span_type: NextNodeServer.getLayoutOrPageModule。

此 span 表示加载布局或页面的代码模块。

属性

next.span_name
next.span_type
next.segment

`开始响应`

next.span_type: NextNodeServer.startResponse。

此零长度 span 表示响应中发送第一个字节的时间。