BrowserPerformanceClient class

Extends

Méthodes

addQueueMeasurement(string, string, number, boolean)

Calcule et ajoute la mesure du temps de file d’attente pour un événement de performances donné.

generateId()
setPreQueueTime(PerformanceEvents, string)

Ajoute le temps de pré-file d’attente à la carte preQueueTimeByCorrelationId.

startMeasurement(string, string)

Commence à mesurer les performances d’une opération donnée. Retourne une fonction qui doit être utilisée pour mettre fin à la mesure. Capture également la visibilité de la page du navigateurState.

Méthodes héritées

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

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

addPerformanceCallback(PerformanceCallbackFunction)

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

calculateQueuedTime(number, number)

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.

discardMeasurements(string)

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

emitEvents(PerformanceEvent[], string)

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

endMeasurement(PerformanceEvent, unknown, AccountInfo)

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.

getPreQueueTime(string, string)

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

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

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

removePerformanceCallback(string)

Supprime un rappel inscrit avec addPerformanceCallback.

startPerformanceMeasurement(string, string)

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.

Détails du constructeur

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)

Paramètres

configuration
Configuration
intFields

Set<string>

abbreviations

Map<string, string>

Détails de la méthode

addQueueMeasurement(string, string, number, boolean)

Calcule et ajoute la mesure du temps de file d’attente pour un événement de performances donné.

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

Paramètres

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indicateur pour les mesures de file d’attente effectuées manuellement

generateId()

function generateId(): string

Retours

string

setPreQueueTime(PerformanceEvents, string)

Ajoute le temps de pré-file d’attente à la carte preQueueTimeByCorrelationId.

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

Paramètres

eventName
PerformanceEvents
correlationId

string

startMeasurement(string, string)

Commence à mesurer les performances d’une opération donnée. Retourne une fonction qui doit être utilisée pour mettre fin à la mesure. Capture également la visibilité de la page du navigateurState.

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

Paramètres

measureName

string

correlationId

string

Retours

Détails de la méthode héritée

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

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

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

Paramètres

fields

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

correlationId

string

Hérité de PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

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

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Paramètres

Retours

string

Hérité de PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

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

preQueueTime

number

currentTime

number

Retours

number

Hérité de PerformanceClient.calculateQueuedTime

discardMeasurements(string)

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

function discardMeasurements(correlationId: string)

Paramètres

correlationId

string

Hérité de PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

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

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

Paramètres

events

PerformanceEvent[]

correlationId

string

Hérité de PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

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

error

unknown

account
AccountInfo

Retours

Hérité de PerformanceClient.endMeasurement

getPreQueueTime(string, string)

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

eventName

string

correlationId

string

Retours

number | void

Hérité de PerformanceClient.getPreQueueTime

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

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

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

Paramètres

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identificateur de corrélation {string}

Hérité de PerformanceClient.incrementFields

removePerformanceCallback(string)

Supprime un rappel inscrit avec addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Paramètres

callbackId

string

Retours

boolean

Hérité de PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Avertissement

Cette API est à présent déconseillée.

This method will be removed in the next major version

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

measureName

string

correlationId

string

Retours

Hérité de PerformanceClient.startPerformanceMeasurement