跳转到主内容

接口:TelemetryLogger

定义于:packages/extension-api/src/extension-api.d.ts:4562

一个遥测记录器,可供扩展用于记录使用情况和错误遥测。

记录器包装了一个 sender,但它保证

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

它还启用了一个“回显 UI”,可以打印发送的所有数据,并允许编辑器将未处理的错误转发给相应的扩展。

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

属性

isErrorsEnabled

readonly isErrorsEnabled: boolean

定义于:packages/extension-api/src/extension-api.d.ts:4576

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


isUsageEnabled

readonly isUsageEnabled: boolean

定义于:packages/extension-api/src/extension-api.d.ts:4571

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


onDidChangeEnableStates

readonly onDidChangeEnableStates: Event<TelemetryLogger>

定义于:packages/extension-api/src/extension-api.d.ts:4566

当使用情况或错误遥测的启用状态发生变化时触发的 Event

方法

dispose()

dispose(): void

定义于:packages/extension-api/src/extension-api.d.ts:4611

释放此对象并释放资源。

返回

void


logError()

调用签名

logError(eventName, data?): void

定义于:packages/extension-api/src/extension-api.d.ts:4598

记录一个错误事件。

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

参数
eventName

string

要记录的事件名称

data?

Record<string, any>

要记录的数据

返回值

void

调用签名

logError(error, data?): void

定义于:packages/extension-api/src/extension-api.d.ts:4606

记录一个错误事件。

参数
error

错误

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

data?

Record<string, any>

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

返回值

void


logUsage()

logUsage(eventName, data?): void

定义于:packages/extension-api/src/extension-api.d.ts:4587

记录一个使用情况事件。

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

参数

eventName

string

要记录的事件名称

data?

Record<string, any>

要记录的数据

返回值

void