BrowserPerformanceClient class

Pakiet:

@azure/msal-browser

Rozszerzenie

PerformanceClient

Konstruktory

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

Metody

addQueueMeasurement(string, string, number, boolean)	Oblicza i dodaje pomiar czasu kolejki dla danego zdarzenia wydajności.
generateId()
setPreQueueTime(PerformanceEvents, string)	Dodaje czas przed kolejką do mapy preQueueTimeByCorrelationId.
startMeasurement(string, string)	Rozpoczyna pomiar wydajności dla danej operacji. Zwraca funkcję, która powinna zostać użyta do zakończenia pomiaru. Przechwytuje również widoczność strony przeglądarkiState.

Metody dziedziczone

addFields({[key: string]: {} | undefined}, string)	Zapisuje dodatkowe informacje, które mają być emitowane po opróżnieniu pomiarów
addPerformanceCallback(PerformanceCallbackFunction)	Rejestruje funkcję wywołania zwrotnego w celu odbierania zdarzeń wydajności.
calculateQueuedTime(number, number)	Oblicza różnicę między bieżącym czasem a czasem kolejki funkcji. Uwaga: istnieje możliwość, że czas kolejki wynosi 0, jeśli bieżący czas i czas w kolejce był taki sam.
discardMeasurements(string)	Usuwa miary i dane aux dla danego identyfikatora korelacji.
emitEvents(PerformanceEvent[], string)	Emituje zdarzenia do wszystkich zarejestrowanych wywołań zwrotnych.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Zatrzymuje pomiar wydajności operacji. Powinny być wywoływane bezpośrednio przez klasy PerformanceClient, ponieważ konsumenci powinni zamiast tego używać funkcji zwracanej przez funkcję startMeasurement. Dodaje nowe pole o nazwie "[nazwa zdarzenia]Czas trwania" dla pomiarów podrzędnych, kończy i emituje zdarzenie w inny sposób.
getPreQueueTime(string, string)	Pobiera mapę czasów przed kolejką według identyfikatora korelacji
incrementFields({[key: string]: number | undefined}, string)	Liczniki przyrostowe, które mają być emitowane po opróżnieniu pomiarów
removePerformanceCallback(string)	Usuwa wywołanie zwrotne zarejestrowane za pomocą polecenia addPerformanceCallback.
startPerformanceMeasurement(string, string)	Uruchamia i zwraca implementację interfejsu IPerformanceMeasurement specyficzną dla platformy. Uwaga: tę funkcję można zmienić na abstrakcyjną przy następnym podbieniu wersji głównej.

Szczegóły konstruktora

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

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

Parametry

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

Szczegóły metody

addQueueMeasurement(string, string, number, boolean)

Oblicza i dodaje pomiar czasu kolejki dla danego zdarzenia wydajności.

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

Parametry

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

wskaźnik ręcznego ukończenia pomiarów kolejki

generateId()

function generateId(): string

Zwraca

string

setPreQueueTime(PerformanceEvents, string)

Dodaje czas przed kolejką do mapy preQueueTimeByCorrelationId.

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

Parametry

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Rozpoczyna pomiar wydajności dla danej operacji. Zwraca funkcję, która powinna zostać użyta do zakończenia pomiaru. Przechwytuje również widoczność strony przeglądarkiState.

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

Parametry

measureName

string

correlationId

string

Zwraca

InProgressPerformanceEvent

Szczegóły metody dziedziczonej

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

Zapisuje dodatkowe informacje, które mają być emitowane po opróżnieniu pomiarów

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

Parametry

fields

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

correlationId

string

Dziedziczone z PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Rejestruje funkcję wywołania zwrotnego w celu odbierania zdarzeń wydajności.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

callback

PerformanceCallbackFunction

Zwraca

string

Dziedziczone z PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Oblicza różnicę między bieżącym czasem a czasem kolejki funkcji. Uwaga: istnieje możliwość, że czas kolejki wynosi 0, jeśli bieżący czas i czas w kolejce był taki sam.

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

Parametry

preQueueTime

number

currentTime

number

Zwraca

number

Dziedziczone z PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Usuwa miary i dane aux dla danego identyfikatora korelacji.

function discardMeasurements(correlationId: string)

Parametry

correlationId

string

Dziedziczone z PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Emituje zdarzenia do wszystkich zarejestrowanych wywołań zwrotnych.

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

Parametry

events

PerformanceEvent[]

correlationId

string

Dziedziczone z PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Zatrzymuje pomiar wydajności operacji. Powinny być wywoływane bezpośrednio przez klasy PerformanceClient, ponieważ konsumenci powinni zamiast tego używać funkcji zwracanej przez funkcję startMeasurement. Dodaje nowe pole o nazwie "[nazwa zdarzenia]Czas trwania" dla pomiarów podrzędnych, kończy i emituje zdarzenie w inny sposób.

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

Parametry

event

PerformanceEvent

error

unknown

account

AccountInfo

Zwraca

null | PerformanceEvent

Dziedziczone z PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Pobiera mapę czasów przed kolejką według identyfikatora korelacji

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

Parametry

eventName

string

correlationId

string

Zwraca

number | void

Dziedziczone z PerformanceClient.getPreQueueTime

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

Liczniki przyrostowe, które mają być emitowane po opróżnieniu pomiarów

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

Parametry

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identyfikator korelacji :string}

Dziedziczone z PerformanceClient.incrementFields

removePerformanceCallback(string)

Usuwa wywołanie zwrotne zarejestrowane za pomocą polecenia addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId

string

Zwraca

boolean

Dziedziczone z PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

This method will be removed in the next major version

Uruchamia i zwraca implementację interfejsu IPerformanceMeasurement specyficzną dla platformy. Uwaga: tę funkcję można zmienić na abstrakcyjną przy następnym podbieniu wersji głównej.

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

Parametry

measureName

string

correlationId

string

Zwraca

IPerformanceMeasurement

Dziedziczone z PerformanceClient.startPerformanceMeasurement