PerformanceClient class

套件:

@azure/msal-common

建構函式

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

建立一個 PerformanceClient 實例，這是一個包含核心效能遙測邏輯的抽象類別。

方法

addFields({[key: string]: {} | undefined}, string)	這樣可以節省額外資訊，讓測量值沖洗時會產生更多資訊
addPerformanceCallback(PerformanceCallbackFunction)	註冊回調函式以接收效能事件。
addQueueMeasurement(string, string, number, boolean)	為給定相關 ID 將佇列測量時間加入 QueueMeasurements 陣列。
calculateQueuedTime(number, number)	計算目前時間與函式排隊時間的差異。 注意：如果目前時間和排隊時間相同，排隊時間可以是 0。
discardMeasurements(string)	移除給定相關 id 的測量值與輔助資料。
emitEvents(PerformanceEvent[], string)	會向所有註冊回撥發送事件。
endMeasurement(PerformanceEvent, unknown, AccountInfo)	停止測量操作效能。 應該只由 PerformanceClient 類別直接呼叫，因為消費者應該使用 startMeasurement 回傳的函式。 新增一個名為「[事件名稱]DurationMs」的新欄位用於子測量，否則會完成並發出事件。
generateId()	產生並回傳一個獨特的 ID，通常是 guid。
getPreQueueTime(string, string)	透過相關性 Id 取得預排隊時間的地圖
incrementFields({[key: string]: number | undefined}, string)	當測量值沖洗時，應發出增量計數器
removePerformanceCallback(string)	移除以 addPerformanceCallback 註冊的回撥。
setPreQueueTime(PerformanceEvents, string)	透過相關性 Id 設定預排隊時間
startMeasurement(string, string)	開始衡量特定操作的效能。 回傳一個函數，應該用來結束測量。
startPerformanceMeasurement(string, string)	啟動並回傳針對特定平台的 IPerformanceMeasurement 實作。 注意：此函式可在下一個重大版本提升時改為抽象。

建構函式詳細資料

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

建立一個 PerformanceClient 實例，這是一個包含核心效能遙測邏輯的抽象類別。

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

參數

clientId

string

應用程式的用戶端識別碼

authority

string

應用程式所使用的權限

logger

Logger

應用程式使用的記錄器

libraryName

string

圖書館的名稱

libraryVersion

string

函式庫版本

applicationTelemetry

ApplicationTelemetry

應用程式名稱與版本

intFields

Set<string>

整數場需截斷

abbreviations

Map<string, string>

活動名稱縮寫

方法詳細資料

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

這樣可以節省額外資訊，讓測量值沖洗時會產生更多資訊

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

參數

fields

{[key: string]: {} | undefined}

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction)

註冊回調函式以接收效能事件。

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

參數

callback

PerformanceCallbackFunction

傳回

string

addQueueMeasurement(string, string, number, boolean)

為給定相關 ID 將佇列測量時間加入 QueueMeasurements 陣列。

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

參數

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

手動完成隊列測量的指示器

calculateQueuedTime(number, number)

計算目前時間與函式排隊時間的差異。 注意：如果目前時間和排隊時間相同，排隊時間可以是 0。

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

參數

preQueueTime

number

currentTime

number

傳回

number

discardMeasurements(string)

移除給定相關 id 的測量值與輔助資料。

function discardMeasurements(correlationId: string)

參數

correlationId

string

emitEvents(PerformanceEvent[], string)

會向所有註冊回撥發送事件。

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

參數

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent, unknown, AccountInfo)

停止測量操作效能。 應該只由 PerformanceClient 類別直接呼叫，因為消費者應該使用 startMeasurement 回傳的函式。 新增一個名為「[事件名稱]DurationMs」的新欄位用於子測量，否則會完成並發出事件。

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

參數

event

PerformanceEvent

error

unknown

account

AccountInfo

傳回

null | PerformanceEvent

generateId()

產生並回傳一個獨特的 ID，通常是 guid。

function generateId(): string

傳回

string

getPreQueueTime(string, string)

透過相關性 Id 取得預排隊時間的地圖

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

參數

eventName

string

correlationId

string

傳回

number | void

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

當測量值沖洗時，應發出增量計數器

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

參數

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

{string} 相關識別碼

removePerformanceCallback(string)

移除以 addPerformanceCallback 註冊的回撥。

function removePerformanceCallback(callbackId: string): boolean

參數

callbackId

string

傳回

boolean

setPreQueueTime(PerformanceEvents, string)

透過相關性 Id 設定預排隊時間

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

參數

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

開始衡量特定操作的效能。 回傳一個函數，應該用來結束測量。

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

參數

measureName

string

correlationId

string

傳回

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

警告

此 API 現已淘汰。

This method will be removed in the next major version

啟動並回傳針對特定平台的 IPerformanceMeasurement 實作。 注意：此函式可在下一個重大版本提升時改為抽象。

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

參數

measureName

string

correlationId

string

傳回

IPerformanceMeasurement