使用 Node.js and Express structured logging 发送并验证事件
在受控应用程序边界使用 Node.js and Express structured logging，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
API错误率监控
- 2
定义合同
route_template、方法和status_code
- 3
在结果处发出
在调用 next 之前附加侦听器，以便记录最终响应状态。
- 4
核实证据
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
开始之前
开始之前
- 服务器端 TELEMETRY_API_KEY 环境变量
- 应用程序启动期间初始化的 telemetry-sh 包
- 稳定的路由模板而不是原始请求 URL
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Node.js and Express structured logging事件
app.use((req, res, next) => {
const startedAt = performance.now();
res.on("finish", async () => {
try {
await telemetry.log("api_request_completed", {
route_template: req.route?.path ?? "unmatched",
method: req.method,
status_code: res.statusCode,
status: res.statusCode >= 500 ? "failed" : "success",
latency_ms: Math.round(performance.now() - startedAt),
request_id: req.id,
release: process.env.APP_RELEASE,
});
} catch {
try { console.warn("Telemetry delivery unconfirmed"); } catch {}
}
});
next();
});事件结构
route_template、方法和status_code
状态和分类 error_type
latency_ms、request_id，并释放
检查配置
检查站 1
在调用 next 之前附加侦听器，以便记录最终响应状态。
检查站 2
使用匹配的 Express 路由模式和路由器基本 URL；切勿发送查询字符串或原始请求正文。
检查站 3
确定中止的请求是否需要单独的状态并在测试中执行该分支。
检查站 4
在 finish 监听器内部捕获发送失败，避免产生未处理的 Promise 拒绝。诊断消息应使用固定文本，并同时保护诊断输出。
检查站 5
此监听器未实现发送时限、持久队列、重试或关闭时排空。生产环境需配置有界发送和生命周期处理。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
Node.js and Express structured logging 验证查询
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
在哪里记录事件
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件模式示例
此工作流的事件模式
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
更多 SQL 示例
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
按路由计算API错误率
在至少有 20 次请求的 API 路由中，哪些路由的 5xx 错误率最高？
打开查询示例计算 p50、p95 和 p99 API 延迟
哪些端点的尾部延迟最差？
打开查询示例按路由计算API超时率
哪些 API 路由超时的频率足以影响用户？
打开查询示例比较依赖性 p95 延迟
哪些下游依赖项的尾部延迟和故障率最差？
打开查询示例按客户影响对错误指纹进行排名
哪些错误组影响最多的客户帐户？
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成