SuperAPI AI 工具集

telemetry-instrumentation

办公与效率

查看项目

更新于 10-16 00:32

技能介绍

用途:为 vscode-documentdb 扩展编写可分析的遥测埋点,指导在功能中新增遥测、丰富已有事件属性并遵循统一约定。

主要能力:@microsoft/vscode-azext-utils 会自动采集 duration、result(Succeeded/Failed/Canceled)、error 与 errorMessage、取消检测、机器/会话 ID 及扩展元数据,不要手动重复。核心 API 为 callWithTelemetryAndErrorHandling(eventId, callback),创建事件并执行回调,返回值透传。命令注册通过 registerCommandWithTreeNodeUnwrapping 等配合 withCommandCorrelation 自动埋点;Webview tRPC 通过 publicProcedureWithTelemetry 自动发出 documentDB.rpc.{type}.{path}。

用法:事件名用点分层次(如 connect、connect.getmetadata、connect.promptForCredentials)。属性用 camelCase(命名空间前缀用 prefix_camelCase),布尔值用 'true'/'false' 三元写法,想聚合的数字应放 measurements 而非 properties。可用 journeyCorrelationId、connectionCorrelationId、shellSessionId 关联多个事件。父事件内嵌套调用可做子步骤计时;用 suppressIfSuccessful、suppressAll 抑制高频事件,用 errorHandling 控制显示与重抛;连接字符串等敏感信息用 maskSensitiveValuesInTelemetry 脱敏。

场景与限制:适用于需要统计功能使用、排查错误或分析用户旅程的场景。避免手动计时、拆分成功/失败两个块、在 void 中抛出错误,也不要对手动统计成功次数的事件使用 suppressIfSuccessful。具体扩展限制与配置暂未提供。