PerformanceClient class

Pakiet:

@azure/msal-common

Konstruktory

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

Tworzy wystąpienie klasy PerformanceClient, abstrakcyjnej klasy zawierającej podstawową logikę telemetrii wydajności.

Metody

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.
addQueueMeasurement(string, string, number, boolean)	Dodaje czas pomiaru kolejki do tablicy QueueMeasurements dla danego identyfikatora korelacji.
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.
generateId()	Generuje i zwraca unikatowy identyfikator, zazwyczaj identyfikator GUID.
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.
setPreQueueTime(PerformanceEvents, string)	Ustawia czas przed kolejką według identyfikatora korelacji
startMeasurement(string, string)	Rozpoczyna pomiar wydajności dla danej operacji. Zwraca funkcję, która powinna zostać użyta do zakończenia pomiaru.
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

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

Tworzy wystąpienie klasy PerformanceClient, abstrakcyjnej klasy zawierającej podstawową logikę telemetrii wydajności.

new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>, abbreviations?: Map<string, string>)

Parametry

clientId

string

Identyfikator klienta aplikacji

authority

string

Urząd używany przez aplikację

logger

Logger

Rejestrator używany przez aplikację

libraryName

string

Nazwa biblioteki

libraryVersion

string

Wersja biblioteki

applicationTelemetry

ApplicationTelemetry

nazwa i wersja aplikacji

intFields

Set<string>

Pola całkowite do obcinania

abbreviations

Map<string, string>

skróty nazw zdarzeń

Szczegóły metody

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

addPerformanceCallback(PerformanceCallbackFunction)

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

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

callback

PerformanceCallbackFunction

Zwraca

string

addQueueMeasurement(string, string, number, boolean)

Dodaje czas pomiaru kolejki do tablicy QueueMeasurements dla danego identyfikatora korelacji.

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

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

discardMeasurements(string)

Usuwa miary i dane aux dla danego identyfikatora korelacji.

function discardMeasurements(correlationId: string)

Parametry

correlationId

string

emitEvents(PerformanceEvent[], string)

Emituje zdarzenia do wszystkich zarejestrowanych wywołań zwrotnych.

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

Parametry

events

PerformanceEvent[]

correlationId

string

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

generateId()

Generuje i zwraca unikatowy identyfikator, zazwyczaj identyfikator GUID.

function generateId(): string

Zwraca

string

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

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}

removePerformanceCallback(string)

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

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId

string

Zwraca

boolean

setPreQueueTime(PerformanceEvents, string)

Ustawia czas przed kolejką według identyfikatora korelacji

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.

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

Parametry

measureName

string

correlationId

string

Zwraca

InProgressPerformanceEvent

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