PerformanceClient class

创建 PerformanceClient 的实例，这是包含核心性能遥测逻辑的抽象类。

new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>, abbreviations?: Map<string, string>)

参数

保存刷新度量值时要发出的额外信息

function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)

参数

注册回调函数以接收性能事件。

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

参数

返回

将队列度量时间添加到 QueueMeasurements 数组中，以获取给定的相关 ID。

function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)

参数

计算函数排队时的当前时间和时间之间的差异。 注意：如果当前时间和排队时间相同，则队列时间可能为 0。

function calculateQueuedTime(preQueueTime: number, currentTime: number): number

参数

返回

删除给定相关 ID 的度量值和辅助数据。

function discardMeasurements(correlationId: string)

参数

向所有已注册的回调发出事件。

function emitEvents(events: PerformanceEvent[], correlationId?: string)

参数

停止测量操作的性能。 应仅由 PerformanceClient 类直接调用，因为使用者应改用 startMeasurement 返回的函数。 为子度量添加一个名为“[事件名称]DurationMs”的新字段，否则完成并发出事件。

function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent

参数

返回

生成并返回唯一 ID，通常是 guid。

function generateId(): string

返回

按关联 ID 获取预队列时间的映射

function getPreQueueTime(eventName: string, correlationId: string): number | void

参数

返回

刷新度量值时要发出的递增计数器

function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)

参数

删除向 addPerformanceCallback 注册的回调。

function removePerformanceCallback(callbackId: string): boolean

参数

返回

按关联 ID 设置预队列时间

function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)

参数

开始测量给定操作的性能。 返回一个函数，该函数应用于结束度量。

function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent

参数

返回

启动并返回特定于平台的 IPerformanceMeasurement 实现。 注意：此函数可以在下一个主要版本颠簸处更改为抽象。

function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement

参数

返回