BrowserPerformanceClient class

Paket:

@azure/msal-browser

Memperluas

PerformanceClient

Konstruktor

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

Metode

addQueueMeasurement(string, string, number, boolean)	Menghitung dan menambahkan pengukuran waktu antrean untuk peristiwa performa tertentu.
generateId()
setPreQueueTime(PerformanceEvents, string)	Menambahkan waktu pra-antrean ke peta preQueueTimeByCorrelationId.
startMeasurement(string, string)	Mulai mengukur performa untuk operasi tertentu. Mengembalikan fungsi yang harus digunakan untuk mengakhiri pengukuran. Juga menangkap visibilitas halaman browserState.

Metode yang Diwarisi

addFields({[key: string]: {} | undefined}, string)	Menyimpan informasi tambahan yang akan dipancarkan ketika pengukuran dihapus
addPerformanceCallback(PerformanceCallbackFunction)	Mendaftarkan fungsi panggilan balik untuk menerima peristiwa performa.
calculateQueuedTime(number, number)	Menghitung perbedaan antara waktu dan waktu saat ini ketika fungsi diantrekan. Catatan: Dimungkinkan untuk memiliki 0 sebagai waktu antrean jika waktu saat ini dan waktu antrean sama.
discardMeasurements(string)	Menghapus pengukuran dan data aux untuk id korelasi tertentu.
emitEvents(PerformanceEvent[], string)	Memancarkan peristiwa ke semua panggilan balik terdaftar.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Berhenti mengukur performa untuk operasi. Hanya boleh dipanggil langsung oleh kelas PerformanceClient, karena konsumen harus menggunakan fungsi yang dikembalikan oleh startMeasurement. Menambahkan bidang baru bernama "[nama peristiwa]DurationMs" untuk sub-pengukuran, menyelesaikan, dan memancarkan peristiwa jika tidak.
getPreQueueTime(string, string)	Mendapatkan peta waktu pra-antrean dengan Id korelasi
incrementFields({[key: string]: number | undefined}, string)	Penghitung kenaikan yang akan dipancarkan ketika pengukuran dibuang
removePerformanceCallback(string)	Menghapus panggilan balik yang terdaftar dengan addPerformanceCallback.
startPerformanceMeasurement(string, string)	Memulai dan mengembalikan implementasi IPerformanceMeasurement khusus platform. Catatan: fungsi ini dapat diubah menjadi abstrak pada benjolan versi utama berikutnya.

Detail Konstruktor

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

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

Parameter

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

Detail Metode

addQueueMeasurement(string, string, number, boolean)

Menghitung dan menambahkan pengukuran waktu antrean untuk peristiwa performa tertentu.

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

Parameter

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indikator untuk pengukuran antrean yang diselesaikan secara manual

generateId()

function generateId(): string

Mengembalikan

string

setPreQueueTime(PerformanceEvents, string)

Menambahkan waktu pra-antrean ke peta preQueueTimeByCorrelationId.

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

Parameter

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Mulai mengukur performa untuk operasi tertentu. Mengembalikan fungsi yang harus digunakan untuk mengakhiri pengukuran. Juga menangkap visibilitas halaman browserState.

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

Parameter

measureName

string

correlationId

string

Mengembalikan

InProgressPerformanceEvent

Detail Metode yang Diwarisi

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

Menyimpan informasi tambahan yang akan dipancarkan ketika pengukuran dihapus

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

Parameter

fields

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

correlationId

string

Diwariskan Dari PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Mendaftarkan fungsi panggilan balik untuk menerima peristiwa performa.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

callback

PerformanceCallbackFunction

Mengembalikan

string

Diwariskan Dari PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Menghitung perbedaan antara waktu dan waktu saat ini ketika fungsi diantrekan. Catatan: Dimungkinkan untuk memiliki 0 sebagai waktu antrean jika waktu saat ini dan waktu antrean sama.

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

Parameter

preQueueTime

number

currentTime

number

Mengembalikan

number

Diwariskan Dari PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Menghapus pengukuran dan data aux untuk id korelasi tertentu.

function discardMeasurements(correlationId: string)

Parameter

correlationId

string

Diwariskan Dari PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Memancarkan peristiwa ke semua panggilan balik terdaftar.

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

Parameter

events

PerformanceEvent[]

correlationId

string

Diwariskan Dari PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Berhenti mengukur performa untuk operasi. Hanya boleh dipanggil langsung oleh kelas PerformanceClient, karena konsumen harus menggunakan fungsi yang dikembalikan oleh startMeasurement. Menambahkan bidang baru bernama "[nama peristiwa]DurationMs" untuk sub-pengukuran, menyelesaikan, dan memancarkan peristiwa jika tidak.

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

Parameter

event

PerformanceEvent

error

unknown

account

AccountInfo

Mengembalikan

null | PerformanceEvent

Diwariskan Dari PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Mendapatkan peta waktu pra-antrean dengan Id korelasi

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

Parameter

eventName

string

correlationId

string

Mengembalikan

number | void

Diwariskan Dari PerformanceClient.getPreQueueTime

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

Penghitung kenaikan yang akan dipancarkan ketika pengukuran dibuang

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

Parameter

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Pengidentifikasi korelasi {string}

Diwariskan Dari PerformanceClient.incrementFields

removePerformanceCallback(string)

Menghapus panggilan balik yang terdaftar dengan addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameter

callbackId

string

Mengembalikan

boolean

Diwariskan Dari PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Peringatan

API ini sudah tidak digunakan lagi.

This method will be removed in the next major version

Memulai dan mengembalikan implementasi IPerformanceMeasurement khusus platform. Catatan: fungsi ini dapat diubah menjadi abstrak pada benjolan versi utama berikutnya.

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

Parameter

measureName

string

correlationId

string

Mengembalikan

IPerformanceMeasurement

Diwariskan Dari PerformanceClient.startPerformanceMeasurement