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 の測定値と aux データを削除します。
emitEvents(PerformanceEvent[], string)	登録されているすべてのコールバックにイベントを出力します。
endMeasurement(PerformanceEvent, unknown, AccountInfo)	操作のパフォーマンスの測定を停止します。 コンシューマーは代わりに startMeasurement によって返される関数を使用する必要があるので、PerformanceClient クラスによって直接呼び出す必要があります。 サブ測定の "[イベント名]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

アプリケーションのクライアント ID

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 の測定値と aux データを削除します。

function discardMeasurements(correlationId: string)

パラメーター

correlationId

string

emitEvents(PerformanceEvent[], string)

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

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

パラメーター

events

PerformanceEvent[]

correlationId

string

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

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