PerformanceClient class

Balíček:

@azure/msal-common

Konstruktory

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

Vytvoří instanci PerformanceClient, abstraktní třídu obsahující základní logiku telemetrie výkonu.

Metody

addFields({[key: string]: {} | undefined}, string)	Uloží další informace, které se mají vygenerovat při vyprázdnění měření.
addPerformanceCallback(PerformanceCallbackFunction)	Zaregistruje funkci zpětného volání pro příjem událostí výkonu.
addQueueMeasurement(string, string, number, boolean)	Přidá čas měření fronty do pole QueueMeasurements pro dané ID korelace.
calculateQueuedTime(number, number)	Vypočítá rozdíl mezi aktuálním časem a časem, kdy byla funkce zařazena do fronty. Poznámka: Jako čas fronty je možné mít 0, pokud aktuální čas a čas zařazený do fronty byl stejný.
discardMeasurements(string)	Odebere měření a pomocné údaje pro dané ID korelace.
emitEvents(PerformanceEvent[], string)	Generuje události do všech registrovaných zpětných volání.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Zastaví měření výkonu operace. Funkce vrácená funkcí startMeasurement by měla být volána pouze přímo třídami PerformanceClient, protože příjemci by měli místo toho použít funkci vrácenou funkcí startMeasurement. Přidá nové pole s názvem [název události]DurationMs pro dílčí měření, dokončí a vygeneruje událost jinak.
generateId()	Vygeneruje a vrací jedinečné ID, obvykle identifikátor GUID.
getPreQueueTime(string, string)	Získá mapování časů před frontou podle ID korelace
incrementFields({[key: string]: number | undefined}, string)	Čítače inkrementace, které se mají vyprázdnit při vyprázdnění měření
removePerformanceCallback(string)	Odebere zpětné volání registrované pomocí addPerformanceCallback.
setPreQueueTime(PerformanceEvents, string)	Nastaví čas před frontou podle ID korelace.
startMeasurement(string, string)	Spustí měření výkonu dané operace. Vrátí funkci, která by měla být použita k ukončení měření.
startPerformanceMeasurement(string, string)	Spustí a vrátí implementaci IPerformanceMeasurement specifickou pro platformu. Poznámka: Tuto funkci je možné změnit na abstrakci při dalším nárazu hlavní verze.

Podrobnosti konstruktoru

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

Vytvoří instanci PerformanceClient, abstraktní třídu obsahující základní logiku telemetrie výkonu.

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

Parametry

clientId

string

ID klienta aplikace

authority

string

Autorita používaná aplikací

logger

Logger

Protokolovací nástroj používaný aplikací

libraryName

string

Název knihovny

libraryVersion

string

Verze knihovny

applicationTelemetry

ApplicationTelemetry

název a verze aplikace

intFields

Set<string>

Celočíselná pole, která se mají zkrátit

abbreviations

Map<string, string>

zkratky názvů událostí

Podrobnosti metody

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

Uloží další informace, které se mají vygenerovat při vyprázdnění měření.

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

Parametry

fields

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

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction)

Zaregistruje funkci zpětného volání pro příjem událostí výkonu.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

callback

PerformanceCallbackFunction

Návraty

string

addQueueMeasurement(string, string, number, boolean)

Přidá čas měření fronty do pole QueueMeasurements pro dané ID korelace.

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

Parametry

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indikátor pro ručně dokončené měření fronty

calculateQueuedTime(number, number)

Vypočítá rozdíl mezi aktuálním časem a časem, kdy byla funkce zařazena do fronty. Poznámka: Jako čas fronty je možné mít 0, pokud aktuální čas a čas zařazený do fronty byl stejný.

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

Parametry

preQueueTime

number

currentTime

number

Návraty

number

discardMeasurements(string)

Odebere měření a pomocné údaje pro dané ID korelace.

function discardMeasurements(correlationId: string)

Parametry

correlationId

string

emitEvents(PerformanceEvent[], string)

Generuje události do všech registrovaných zpětných volání.

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

Parametry

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Zastaví měření výkonu operace. Funkce vrácená funkcí startMeasurement by měla být volána pouze přímo třídami PerformanceClient, protože příjemci by měli místo toho použít funkci vrácenou funkcí startMeasurement. Přidá nové pole s názvem [název události]DurationMs pro dílčí měření, dokončí a vygeneruje událost jinak.

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

Parametry

event

PerformanceEvent

error

unknown

account

AccountInfo

Návraty

null | PerformanceEvent

generateId()

Vygeneruje a vrací jedinečné ID, obvykle identifikátor GUID.

function generateId(): string

Návraty

string

getPreQueueTime(string, string)

Získá mapování časů před frontou podle ID korelace

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

Parametry

eventName

string

correlationId

string

Návraty

number | void

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

Čítače inkrementace, které se mají vyprázdnit při vyprázdnění měření

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

Parametry

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identifikátor korelace {string}

removePerformanceCallback(string)

Odebere zpětné volání registrované pomocí addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId

string

Návraty

boolean

setPreQueueTime(PerformanceEvents, string)

Nastaví čas před frontou podle ID korelace.

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

Parametry

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Spustí měření výkonu dané operace. Vrátí funkci, která by měla být použita k ukončení měření.

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

Parametry

measureName

string

correlationId

string

Návraty

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

Upozornění

Toto rozhraní API je teď zastaralé.

This method will be removed in the next major version

Spustí a vrátí implementaci IPerformanceMeasurement specifickou pro platformu. Poznámka: Tuto funkci je možné změnit na abstrakci při dalším nárazu hlavní verze.

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

Parametry

measureName

string

correlationId

string

Návraty

IPerformanceMeasurement