MongoDB Operation Telemetry:从边界到验证行
在受控应用程序边界使用 MongoDB Operation Telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。
- 1
选择结果
慢运行分析
- 2
定义合同
database_system、操作、collection_name、query_fingerprint、释放
- 3
埋点边界
将应用程序操作与数据库命令分开命名,以便仪表板在查询实现发生变化时保持稳定。
- 4
核实证据
Exercise a known fixture, then inspect mongodb_operation_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- MongoDB Node.js 驱动程序和 telemetry-sh 初始化服务器端
- 不包括集合文档或过滤器值的有界操作分类法
- 应用程序计时和数据库分析器诊断之间的区别回顾
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
MongoDB Operation Telemetry事件
await telemetry.log("mongodb_operation_completed", {
database_system: "mongodb",
operation: "workspace_activity.aggregate",
collection_name: "workspace_activity",
query_fingerprint: "workspace_activity_summary_v3",
status: "success",
duration_ms: Math.round(performance.now() - startedAt),
result_count: results.length,
retry_count: 0,
transaction_status: "not_started",
read_preference: "primaryPreferred",
route_template: "/api/workspaces/:workspaceId/activity",
release: process.env.APP_RELEASE,
});活动合约
database_system、操作、collection_name、query_fingerprint、释放
状态、duration_ms、result_count、retry_count 和 transaction_status
read_preference、write_concern_category、route_template 和 error_type
实施检查点
检查站 1
将应用程序操作与数据库命令分开命名,以便仪表板在查询实现发生变化时保持稳定。
检查站 2
将过滤器、更新文档、聚合管道、返回文档、连接字符串和不受限制的驱动程序错误排除在事件之外。
检查站 3
有选择地使用 MongoDB 数据库分析器进行本机查询诊断;其捕获的数据可能包括敏感的查询详细信息,并且需要自己的访问和保留审查。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。
MongoDB Operation Telemetry 验证查询
SELECT *
FROM mongodb_operation_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID,所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 SQL 查询 API
对结构化事件表运行只读 DataFusion SQL 并重用结果。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。
通过指纹查找缓慢的数据库查询
哪些数据库操作始终慢到足以进行调查?
打开查询示例按总时间影响对数据库查询进行排名
哪个数据库操作消耗的累积请求时间最多?
打开查询示例计算数据库事务回滚率
哪些服务回滚了异常份额的数据库事务?
打开查询示例测量长时间运行的数据库事务
哪些应用程序事务类别保持开放时间最长?
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成