node-postgres Pool and Query Telemetry：从边界到验证行
在受控应用程序边界使用 node-postgres Pool and Query Telemetry，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
Postgres 连接池监控
- 2
定义合同
query_fingerprint、服务、database_name、状态和 duration_ms
- 3
埋点边界
从调用站点传递有界指纹，而不是从原始 SQL 派生它。
- 4
核实证据
Exercise a known fixture, then inspect database_query_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- 带有共享池的 pg 包
- 应用程序拥有的操作指纹
- 服务器端TELEMETRY_API_KEY
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
node-postgres Pool and Query Telemetry事件
import { Pool } from "pg";
import telemetry from "telemetry-sh";
const pool = new Pool({ max: 10 });
const SAFE_DATABASE_ERROR_CODES = new Set(["40001", "40P01", "55P03", "57014"]);
function classifyDatabaseError(error) {
return error && typeof error === "object" &&
"code" in error &&
SAFE_DATABASE_ERROR_CODES.has(String(error.code))
? String(error.code)
: "database_error";
}
async function runDatabaseOperation({
queryFingerprint,
text,
values,
}) {
const acquireStartedAt = performance.now();
let client;
try {
client = await pool.connect();
const acquisitionWaitMs = performance.now() - acquireStartedAt;
const queryStartedAt = performance.now();
const result = await client.query(text, values);
await telemetry.log("database_query_completed", {
query_fingerprint: queryFingerprint,
service: "checkout-api",
database_name: "app_production",
status: "success",
duration_ms: Math.round(performance.now() - queryStartedAt),
acquisition_wait_ms: Math.round(acquisitionWaitMs),
rows_returned: result.rowCount ?? result.rows.length,
active_connections: pool.totalCount - pool.idleCount,
idle_connections: pool.idleCount,
max_connections: pool.options.max ?? 10,
waiting_count: pool.waitingCount,
release: process.env.APP_RELEASE,
environment: process.env.NODE_ENV,
});
return result;
} catch (error) {
await telemetry.log("database_query_completed", {
query_fingerprint: queryFingerprint,
service: "checkout-api",
database_name: "app_production",
status: "failed",
duration_ms: Math.round(performance.now() - acquireStartedAt),
error_type: classifyDatabaseError(error),
active_connections: pool.totalCount - pool.idleCount,
idle_connections: pool.idleCount,
max_connections: pool.options.max ?? 10,
waiting_count: pool.waitingCount,
release: process.env.APP_RELEASE,
environment: process.env.NODE_ENV,
});
throw error;
} finally {
client?.release();
}
}活动合约
query_fingerprint、服务、database_name、状态和 duration_ms
active_connections、idle_connections、max_connections 和 waiting_count
acquisition_wait_ms、rows_returned、error_type、版本和环境
实施检查点
检查站 1
从调用站点传递有界指纹，而不是从原始 SQL 派生它。
检查站 2
将连接获取与查询执行分开测量，这样池争用就不会被误认为是数据库工作。
检查站 3
通过白名单记录驱动程序错误代码，并且绝不转发连接字符串、查询参数或原始数据库消息。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
node-postgres Pool and Query Telemetry 验证查询
SELECT *
FROM database_query_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 SQL 查询 API
对结构化事件表运行只读 DataFusion SQL 并重用结果。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
通过指纹查找缓慢的数据库查询
哪些数据库操作始终慢到足以进行调查？
打开查询示例按总时间影响对数据库查询进行排名
哪个数据库操作消耗的累积请求时间最多？
打开查询示例测量数据库连接池饱和度
哪些应用程序池使调用者等待数据库连接？
打开查询示例测量数据库连接超时和改动
哪些服务和区域显示出不健康的数据库连接流失？
打开查询示例计算数据库事务回滚率
哪些服务回滚了异常份额的数据库事务？
打开查询示例测量长时间运行的数据库事务
哪些应用程序事务类别保持开放时间最长？
打开查询示例查找数据库锁等待和死锁
哪些数据库操作会造成最严重的锁争用？
打开查询示例通过 SQLSTATE 和版本分析数据库错误
应用程序发布后哪些数据库错误类别增加了？
打开查询示例测量数据库复制和 CDC 延迟
哪些副本或 CDC 使用者落后于源数据库？
打开查询示例按区域测量数据库副本的陈旧程度
哪些副本区域正在提供过时或失败的读取？
打开查询示例按版本跟踪数据库迁移失败
哪些版本包含失败或回滚的数据库迁移？
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成