PerformanceClient class

Hiermee maakt u een exemplaar van PerformanceClient, een abstracte klasse die de basislogica voor prestatietelemetrie bevat.

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

Parameters

Slaat extra informatie op die moet worden verzonden wanneer de metingen worden leeggemaakt

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

Parameters

Registreert een callback-functie om prestatie-gebeurtenissen te ontvangen.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Retouren

Hiermee wordt de meettijd van de wachtrij toegevoegd aan queueMeasurements-matrix voor de opgegeven correlatie-id.

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

Parameters

Berekent het verschil tussen de huidige tijd en tijd waarop de functie in de wachtrij is geplaatst. Opmerking: het is mogelijk om 0 te hebben als de wachtrijtijd als de huidige tijd en de in de wachtrij geplaatste tijd hetzelfde waren.

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

Parameters

Retouren

Hiermee verwijdert u metingen en aux-gegevens voor een bepaalde correlatie-id.

function discardMeasurements(correlationId: string)

Parameters

Verzendt gebeurtenissen naar alle geregistreerde callbacks.

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

Parameters

Stopt met het meten van de prestaties voor een bewerking. Moet alleen rechtstreeks worden aangeroepen door PerformanceClient-klassen, omdat consumenten in plaats daarvan de functie moeten gebruiken die wordt geretourneerd door startMeasurement. Voegt een nieuw veld toe met de naam [gebeurtenisnaam]DurationMs voor submetingen, voltooit en verzendt een gebeurtenis anders.

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

Parameters

Retouren

Genereert en retourneert een unieke id, meestal een GUID.

function generateId(): string

Retouren

Kaart van pre-wachtrijtijden ophalen op correlatie-id

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

Parameters

Retouren

Incrementele tellers die moeten worden verzonden wanneer de metingen worden leeggemaakt

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

Parameters

Hiermee verwijdert u een callback geregistreerd bij addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameters

Retouren

Stelt de tijd vóór de wachtrij in op correlatie-id

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

Parameters

Begint met het meten van de prestaties voor een bepaalde bewerking. Retourneert een functie die moet worden gebruikt om de meting te beëindigen.

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

Parameters

Retouren

Hiermee wordt een platformspecifieke implementatie van IPerformanceMeasurement gestart en geretourneerd. Opmerking: deze functie kan worden gewijzigd om te abstraheren op de volgende grote versie-bump.

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

Parameters

Retouren