BrowserPerformanceClient class

パッケージ:

@azure/msal-browser

Extends

PerformanceClient

コンストラクター

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

メソッド

addQueueMeasurement(string, string, number, boolean)	特定のパフォーマンス イベントのキュー時間測定を計算して追加します。
generateId()
setPreQueueTime(PerformanceEvents, string)	preQueueTimeByCorrelationId マップに事前キュー時間を追加します。
startMeasurement(string, string)	特定の操作のパフォーマンスの測定を開始します。 測定を終了するために使用する関数を返します。 ブラウザー ページの visibilityState もキャプチャします。

継承されたメソッド

addFields({[key: string]: {} | undefined}, string)	測定値がフラッシュされたときに出力される追加情報を保存します
addPerformanceCallback(PerformanceCallbackFunction)	パフォーマンス イベントを受信するコールバック関数を登録します。
calculateQueuedTime(number, number)	関数がキューに登録された現在の時刻と時刻の差を計算します。 注: 現在の時刻とキューに入っている時刻が同じ場合は、キュー時間として 0 を指定できます。
discardMeasurements(string)	特定の関連付け ID の測定値と aux データを削除します。
emitEvents(PerformanceEvent[], string)	登録されているすべてのコールバックにイベントを出力します。
endMeasurement(PerformanceEvent, unknown, AccountInfo)	操作のパフォーマンスの測定を停止します。 コンシューマーは代わりに startMeasurement によって返される関数を使用する必要があるので、PerformanceClient クラスによって直接呼び出す必要があります。 サブ測定の "[イベント名]DurationMs" という名前の新しいフィールドを追加し、それ以外の場合はイベントを完了して出力します。
getPreQueueTime(string, string)	関連付け ID によるキュー前の時間のマップを取得します。
incrementFields({[key: string]: number | undefined}, string)	測定値がフラッシュされたときに出力されるインクリメント カウンター
removePerformanceCallback(string)	addPerformanceCallback に登録されているコールバックを削除します。
startPerformanceMeasurement(string, string)	IPerformanceMeasurement のプラットフォーム固有の実装を開始して返します。 注: この関数は、次のメジャー バージョンのバンプで抽象に変更できます。

コンストラクターの詳細

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)

パラメーター

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

メソッドの詳細

addQueueMeasurement(string, string, number, boolean)

特定のパフォーマンス イベントのキュー時間測定を計算して追加します。

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

パラメーター

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

手動で完了したキュー測定のインジケーター

generateId()

function generateId(): string

返品

string

setPreQueueTime(PerformanceEvents, string)

preQueueTimeByCorrelationId マップに事前キュー時間を追加します。

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

パラメーター

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

特定の操作のパフォーマンスの測定を開始します。 測定を終了するために使用する関数を返します。 ブラウザー ページの visibilityState もキャプチャします。

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

パラメーター

measureName

string

correlationId

string

返品

InProgressPerformanceEvent

継承済みメソッドの詳細

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

測定値がフラッシュされたときに出力される追加情報を保存します

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

パラメーター

fields

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

correlationId

string

Inherited From PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

パフォーマンス イベントを受信するコールバック関数を登録します。

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

パラメーター

callback

PerformanceCallbackFunction

返品

string

Inherited From PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

関数がキューに登録された現在の時刻と時刻の差を計算します。 注: 現在の時刻とキューに入っている時刻が同じ場合は、キュー時間として 0 を指定できます。

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

パラメーター

preQueueTime

number

currentTime

number

返品

number

Inherited From PerformanceClient.calculateQueuedTime

discardMeasurements(string)

特定の関連付け ID の測定値と aux データを削除します。

function discardMeasurements(correlationId: string)

パラメーター

correlationId

string

Inherited From PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

登録されているすべてのコールバックにイベントを出力します。

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

パラメーター

events

PerformanceEvent[]

correlationId

string

Inherited From PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

操作のパフォーマンスの測定を停止します。 コンシューマーは代わりに startMeasurement によって返される関数を使用する必要があるので、PerformanceClient クラスによって直接呼び出す必要があります。 サブ測定の "[イベント名]DurationMs" という名前の新しいフィールドを追加し、それ以外の場合はイベントを完了して出力します。

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

パラメーター

event

PerformanceEvent

error

unknown

account

AccountInfo

返品

null | PerformanceEvent

Inherited From PerformanceClient.endMeasurement

getPreQueueTime(string, string)

関連付け ID によるキュー前の時間のマップを取得します。

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

パラメーター

eventName

string

correlationId

string

返品

number | void

Inherited From PerformanceClient.getPreQueueTime

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

測定値がフラッシュされたときに出力されるインクリメント カウンター

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

パラメーター

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

{string} 関連付け識別子

Inherited From PerformanceClient.incrementFields

removePerformanceCallback(string)

addPerformanceCallback に登録されているコールバックを削除します。

function removePerformanceCallback(callbackId: string): boolean

パラメーター

callbackId

string

返品

boolean

Inherited From PerformanceClient.removePerformanceCallback

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

Inherited From PerformanceClient.startPerformanceMeasurement