BrowserPerformanceClient class

Paket:

@azure/msal-browser

Extends

PerformanceClient

Oluşturucular

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

Yöntemler

addQueueMeasurement(string, string, number, boolean)	Verilen performans olayı için kuyruk süresi ölçümlerini hesaplar ve ekler.
generateId()
setPreQueueTime(PerformanceEvents, string)	preQueueTimeByCorrelationId eşlemesine kuyruk öncesi süre ekler.
startMeasurement(string, string)	Belirli bir işlemin performansını ölçmeye başlar. Ölçümü sonlandırmak için kullanılması gereken bir işlev döndürür. Ayrıca tarayıcı sayfası visibilityState'i de yakalar.

Devralınan Yöntemler

addFields({[key: string]: {} | undefined}, string)	Ölçümler boşaltıldığında yayılacak ek bilgileri kaydeder
addPerformanceCallback(PerformanceCallbackFunction)	Performans olaylarını almak için geri çağırma işlevini kaydeder.
calculateQueuedTime(number, number)	İşlevin kuyruğa alındığı zaman ile saat arasındaki farkı hesaplar. Not: Geçerli saat ve kuyruğa alınan saat aynıysa kuyruk süresi olarak 0 olması mümkündür.
discardMeasurements(string)	Belirli bir bağıntı kimliği için ölçümleri ve yedek verileri kaldırır.
emitEvents(PerformanceEvent[], string)	Olayları tüm kayıtlı geri çağırmalara yayar.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Bir işlemin performansını ölçmeyi durdurur. Tüketicilerin startMeasurement tarafından döndürülen işlevi kullanması gerektiği için yalnızca doğrudan PerformanceClient sınıfları tarafından çağrılmalıdır. Alt ölçümler için "[olay adı]DurationMs" adlı yeni bir alan ekler, tamamlar ve aksi takdirde bir olay yayar.
getPreQueueTime(string, string)	Bağıntı kimliğine göre kuyruk öncesi zamanların haritasını alır
incrementFields({[key: string]: number | undefined}, string)	Ölçümler boşaltıldığında yayılacak artım sayaçları
removePerformanceCallback(string)	addPerformanceCallback ile kaydedilen bir geri çağırmayı kaldırır.
startPerformanceMeasurement(string, string)	IPerformanceMeasurement'ın platforma özgü uygulamasını başlatır ve döndürür. Not: Bu işlev, bir sonraki ana sürüm tümsekinde soyut olacak şekilde değiştirilebilir.

Oluşturucu Ayrıntıları

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

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

Parametreler

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

Yöntem Ayrıntıları

addQueueMeasurement(string, string, number, boolean)

Verilen performans olayı için kuyruk süresi ölçümlerini hesaplar ve ekler.

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

Parametreler

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

el ile tamamlanan kuyruk ölçümleri göstergesi

generateId()

function generateId(): string

Döndürülenler

string

setPreQueueTime(PerformanceEvents, string)

preQueueTimeByCorrelationId eşlemesine kuyruk öncesi süre ekler.

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

Parametreler

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Belirli bir işlemin performansını ölçmeye başlar. Ölçümü sonlandırmak için kullanılması gereken bir işlev döndürür. Ayrıca tarayıcı sayfası visibilityState'i de yakalar.

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

Parametreler

measureName

string

correlationId

string

Döndürülenler

InProgressPerformanceEvent

Devralınan Yöntemin Ayrıntıları

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

Ölçümler boşaltıldığında yayılacak ek bilgileri kaydeder

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

Parametreler

fields

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

correlationId

string

Devralınan PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Performans olaylarını almak için geri çağırma işlevini kaydeder.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametreler

callback

PerformanceCallbackFunction

Döndürülenler

string

Devralınan Kaynak PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

İşlevin kuyruğa alındığı zaman ile saat arasındaki farkı hesaplar. Not: Geçerli saat ve kuyruğa alınan saat aynıysa kuyruk süresi olarak 0 olması mümkündür.

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

Parametreler

preQueueTime

number

currentTime

number

Döndürülenler

number

Devralınan PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Belirli bir bağıntı kimliği için ölçümleri ve yedek verileri kaldırır.

function discardMeasurements(correlationId: string)

Parametreler

correlationId

string

Devralınan Kaynak PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Olayları tüm kayıtlı geri çağırmalara yayar.

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

Parametreler

events

PerformanceEvent[]

correlationId

string

Devralınan PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Bir işlemin performansını ölçmeyi durdurur. Tüketicilerin startMeasurement tarafından döndürülen işlevi kullanması gerektiği için yalnızca doğrudan PerformanceClient sınıfları tarafından çağrılmalıdır. Alt ölçümler için "[olay adı]DurationMs" adlı yeni bir alan ekler, tamamlar ve aksi takdirde bir olay yayar.

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

Parametreler

event

PerformanceEvent

error

unknown

account

AccountInfo

Döndürülenler

null | PerformanceEvent

Devralınan PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Bağıntı kimliğine göre kuyruk öncesi zamanların haritasını alır

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

Parametreler

eventName

string

correlationId

string

Döndürülenler

number | void

Devralınan PerformanceClient.getPreQueueTime

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

Ölçümler boşaltıldığında yayılacak artım sayaçları

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

Parametreler

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

{string} bağıntı tanımlayıcısı

Devralınan PerformanceClient.incrementFields

removePerformanceCallback(string)

addPerformanceCallback ile kaydedilen bir geri çağırmayı kaldırır.

function removePerformanceCallback(callbackId: string): boolean

Parametreler

callbackId

string

Döndürülenler

boolean

Devralınan PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Uyarı

Bu API artık kullanım dışıdır.

This method will be removed in the next major version

IPerformanceMeasurement'ın platforma özgü uygulamasını başlatır ve döndürür. Not: Bu işlev, bir sonraki ana sürüm tümsekinde soyut olacak şekilde değiştirilebilir.

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

Parametreler

measureName

string

correlationId

string

Döndürülenler

IPerformanceMeasurement

Devralınan PerformanceClient.startPerformanceMeasurement