PerformanceClient class

Skapar en instans av PerformanceClient, en abstrakt klass som innehåller telemetrilogik för kärnprestanda.

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

Parametrar

Sparar extra information som ska genereras när mätningarna töms

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

Parametrar

Registrerar en återanropsfunktion för att ta emot prestandahändelser.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametrar

Returer

Lägger till kömätningstid i QueueMeasurements-matrisen för angivet korrelations-ID.

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

Parametrar

Beräknar skillnaden mellan aktuell tid och tid när funktionen köades. Obs! Det går att ha 0 som kötid om den aktuella tiden och den köade tiden var densamma.

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

Parametrar

Returer

Tar bort mått och aux-data för ett visst korrelations-ID.

function discardMeasurements(correlationId: string)

Parametrar

Genererar händelser till alla registrerade återanrop.

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

Parametrar

Stoppar mätning av prestanda för en åtgärd. Bör bara anropas direkt av PerformanceClient-klasser, eftersom konsumenterna i stället bör använda funktionen som returneras av startMeasurement. Lägger till ett nytt fält med namnet "[event name]DurationMs" för undermätningar, slutför och genererar en händelse i annat fall.

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

Parametrar

Returer

Genererar och returnerar ett unikt ID, vanligtvis ett guid.

function generateId(): string

Returer

Hämtar karta över tider före kön efter korrelations-ID

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

Parametrar

Returer

Öka räknare som ska genereras när mätningarna töms

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

Parametrar

Tar bort ett återanrop som registrerats med addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametrar

Returer

Anger tid före kö efter korrelations-ID

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

Parametrar

Börjar mäta prestanda för en viss åtgärd. Returnerar en funktion som ska användas för att avsluta mätningen.

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

Parametrar

Returer

Startar och returnerar en plattformsspecifik implementering av IPerformanceMeasurement. Obs! Den här funktionen kan ändras till abstrakt vid nästa större versionsuppbubbel.

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

Parametrar

Returer