使用 Pino structured event analytics 发送并验证事件
在受控应用程序边界使用 Pino structured event analytics,保持事件契约较小,并在构建聚合视图之前验证已知结果。
- 1
选择结果
Node.js API可靠性
- 2
定义合同
request_id、route_template、方法、status_code 和状态
- 3
在结果处发出
保留 Pino 作为详细诊断流;仅当请求或工作流到达最终结果时,才会发出单独的紧凑 Telemetry 行。
- 4
核实证据
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
开始之前
开始之前
- Pino configured once and a Telemetry API key 中 a trusted Node.js runtime
- 稳定的路由模板、工作流程名称、请求 ID 和发布标识符
- 针对凭证和私人内容的字段白名单和 Pino 编辑规则
交货设置
安装并初始化服务器端
此服务端示例通过 Log API 发送事件,使用服务端密钥和有时限的 fetch 请求;无需初始化 Telemetry SDK。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install pino- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Pino structured event analytics事件
import pino from "pino";
const logger = pino();
async function recordOutcome(data) {
try {
const receipt = await fetch("https://api.telemetry.sh/log", {
method: "POST",
headers: {
Authorization: process.env.TELEMETRY_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ table: "api_request_completed", data }),
signal: AbortSignal.timeout(2_000),
});
if (!receipt.ok) console.warn("Telemetry ingestion failed", receipt.status);
} catch {
console.warn("Telemetry ingestion unavailable");
}
}
const startedAt = performance.now();
try {
const result = await runCheckout();
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 200,
status: "success",
latency_ms: Math.round(performance.now() - startedAt),
release: process.env.APP_RELEASE,
};
logger.info(outcome, "checkout completed");
await recordOutcome(outcome);
return result;
} catch (error) {
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 500,
status: "failed",
latency_ms: Math.round(performance.now() - startedAt),
error_type: classifyError(error),
release: process.env.APP_RELEASE,
};
logger.error({ ...outcome, err: error }, "checkout failed");
await recordOutcome(outcome);
throw error;
}事件结构
request_id、route_template、方法、status_code 和状态
latency_ms、error_type、发布、环境和服务
account_id 或 tenant_id 仅在批准进行操作分析时
检查配置
检查站 1
保留 Pino 作为详细诊断流;仅当请求或工作流到达最终结果时,才会发出单独的紧凑 Telemetry 行。
检查站 2
在系统之间共享批准的 request_id 以进行关联,但不要将日志消息、请求正文、标头或异常堆栈复制到事件中。
检查站 3
The example waits for a bounded HTTP export while keeping delivery errors separate from checkout results. Use an outbox if you cannot afford to lose events; verify the captured row with SQL.
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。
Pino structured event analytics 验证查询
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。
在哪里记录事件
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID,所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件模式示例
此工作流的事件模式
在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
更多 SQL 示例
针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。
按路由计算 API 请求吞吐量
哪些 API 路由每分钟处理的请求最多?
打开查询示例按路由计算API错误率
在至少有 20 次请求的 API 路由中,哪些路由的 5xx 错误率最高?
打开查询示例计算 p50、p95 和 p99 API 延迟
哪些端点的尾部延迟最差?
打开查询示例按版本比较 API 可靠性
哪些版本会出现更严重的 API 错误或尾部延迟?
打开查询示例按客户影响对错误指纹进行排名
哪些错误组影响最多的客户帐户?
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成