跳转到内容
Telemetry
集成指南

Next.js 服务器事件分析

从 Next.js 路由处理程序和服务器操作发送 SQL 就绪事件,而无需向浏览器公开摄取密钥。

审阅者 Telemetry产品团队 . 埋点合约、隐私边界和实施指南. 审查标准和所有权

有用于
  • 服务器操作结果
  • 路由处理程序可靠性
  • 产品激活事件
实施证据

Next.js Server Event Analytics:从边界到验证行

在受控应用程序边界使用 Next.js Server Event Analytics,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    服务器操作结果

  2. 2

    定义合同

    route_template 或 action_name

  3. 3

    埋点边界

    将 Telemetry 调用保留在路由处理程序、服务器操作或其他仅服务器模块中。

  4. 4

    核实证据

    Exercise a known fixture, then inspect project_created for one correctly typed terminal row.

开始之前

先决条件和界限

  • 仅服务器 TELEMETRY_API_KEY 环境变量
  • 在服务器代码中初始化的 telemetry-sh 包
  • 已命名的工作流程,其成功和失败定义均已记录

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

nextjs-安装

npm安装

bash
npm install telemetry-sh
  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

nextjs

Next.js Server Event Analytics事件

javascript
export async function POST(request) {
  const startedAt = performance.now();
  const result = await createProject(request);

  await telemetry.log("project_created", {
    route_template: "/api/projects",
    status: "success",
    status_code: 201,
    latency_ms: Math.round(performance.now() - startedAt),
    account_id: result.accountId,
    source: "onboarding",
  });

  return Response.json({ id: result.id }, { status: 201 });
}

活动合约

route_template 或 action_name

状态、status_code 和 error_type

latency_ms 加上安全帐户或请求标识符

实施检查点

检查站 1

将 Telemetry 调用保留在路由处理程序、服务器操作或其他仅服务器模块中。

检查站 2

在工作流具有已知结果(包括已处理的故障)后记录事件。

检查站 3

请勿将 API 密钥放入 NEXT_PUBLIC 变量中或发送原始表单数据。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

nextjs-验证

Next.js Server Event Analytics 验证查询

sql
SELECT *
FROM project_created
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

生产边界

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件架构起点

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 仪表板

将经过验证的产品或收入查询转变为集中的决策界面。

相关 SQL 查询示例

用 SQL 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成