跳至主要内容

接口: TelemetryLogger

一个遥测记录器,扩展可以使用它来记录使用情况和错误遥测。

一个记录器包装在 发送器 周围,但它保证

  • 禁用或调整遥测的用户设置得到尊重,并且
  • 潜在的敏感数据被删除

它还启用“回显 UI”,它打印发送的任何数据,并允许编辑器将未处理的错误转发到相应的扩展。

要获取 TelemetryLogger 的实例,请使用 createTelemetryLogger.

属性

isErrorsEnabled

readonly isErrorsEnabled: boolean

此记录器是否启用了错误遥测。

定义在

packages/extension-api/src/extension-api.d.ts:4428


isUsageEnabled

readonly isUsageEnabled: boolean

此记录器是否启用了使用情况遥测。

定义在

packages/extension-api/src/extension-api.d.ts:4423


onDidChangeEnableStates

readonly onDidChangeEnableStates: Event<TelemetryLogger>

一个 Event,当使用情况或错误遥测的启用状态更改时触发。

定义在

packages/extension-api/src/extension-api.d.ts:4418

方法

dispose()

dispose(): void

处理此对象并释放资源。

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:4463


logError()

logError(eventName, data)

logError(eventName, data?): void

记录错误事件。

完成清理、遥测设置检查和数据混合后,调用 TelemetrySender.sendEventData 来记录事件。它与 logUsage 不同,它会在遥测设置为 Error+ 时记录事件。自动支持回显到扩展遥测输出通道。

参数

eventName: string

要记录的事件名称

data?: Record<string, any>

要记录的数据

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:4450

logError(error, data)

logError(error, data?): void

记录错误事件。

参数

error: Error

包含已清除 PII 的堆栈跟踪的错误对象

data?: Record<string, any>

要与堆栈跟踪一起记录的附加数据

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:4458


logUsage()

logUsage(eventName, data?): void

记录使用情况事件。

完成清理、遥测设置检查和数据混合后,调用 TelemetrySender.sendEventData 来记录事件。自动支持回显到扩展遥测输出通道。

参数

eventName: string

要记录的事件名称

data?: Record<string, any>

要记录的数据

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:4439