PerformanceClient class

Crée une instance de PerformanceClient, une classe abstraite contenant la logique de télémétrie de performances de base.

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

Paramètres

Enregistre des informations supplémentaires à émettre lorsque les mesures sont vidées

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

Paramètres

Inscrit une fonction de rappel pour recevoir des événements de performances.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Paramètres

Retours

Ajoute le temps de mesure de file d’attente au tableau QueueMeasurements pour un ID de corrélation donné.

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

Paramètres

Calcule la différence entre l’heure actuelle et l’heure à laquelle la fonction a été mise en file d’attente. Remarque : il est possible d’avoir 0 comme heure de file d’attente si l’heure actuelle et l’heure mise en file d’attente étaient identiques.

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

Paramètres

Retours

Supprime les mesures et les données aux pour un ID de corrélation donné.

function discardMeasurements(correlationId: string)

Paramètres

Émet des événements à tous les rappels inscrits.

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

Paramètres

Arrête de mesurer les performances d’une opération. Doit uniquement être appelé directement par les classes PerformanceClient, car les consommateurs doivent utiliser plutôt la fonction retournée par startMeasurement. Ajoute un nouveau champ nommé « [nom d’événement]DurationMs » pour les sous-mesures, termine et émet un événement dans le cas contraire.

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

Paramètres

Retours

Génère et retourne un ID unique, généralement un guid.

function generateId(): string

Retours

Obtient la carte des heures de pré-file d’attente par ID de corrélation

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

Paramètres

Retours

Incrémenter les compteurs à émettre lorsque les mesures sont vidées

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

Paramètres

Supprime un rappel inscrit avec addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Paramètres

Retours

Définit le temps de pré-file d’attente par ID de corrélation

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

Paramètres

Commence à mesurer les performances d’une opération donnée. Retourne une fonction qui doit être utilisée pour mettre fin à la mesure.

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

Paramètres

Retours

Démarre et retourne une implémentation spécifique à la plateforme d’IPerformanceMeasurement. Remarque : cette fonction peut être modifiée pour être abstraite à l’étape suivante de la version principale.

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

Paramètres

Retours