BrowserPerformanceClient class

Extends

Metodi

addQueueMeasurement(string, string, number, boolean)

Calcola e aggiunge la misurazione del tempo della coda per un determinato evento di prestazioni.

generateId()
setPreQueueTime(PerformanceEvents, string)

Aggiunge il tempo di pre-coda alla mappa preQueueTimeByCorrelationId.

startMeasurement(string, string)

Avvia la misurazione delle prestazioni per una determinata operazione. Restituisce una funzione che deve essere utilizzata per terminare la misurazione. Acquisisce anche visibilityState della pagina del browser.

Metodi ereditati

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

Salva informazioni aggiuntive da generare quando le misurazioni vengono scaricate

addPerformanceCallback(PerformanceCallbackFunction)

Registra una funzione di callback per ricevere eventi di prestazioni.

calculateQueuedTime(number, number)

Calcola la differenza tra l'ora corrente e l'ora in cui è stata accodata la funzione. Nota: è possibile avere 0 come ora della coda se l'ora corrente e l'ora in coda erano uguali.

discardMeasurements(string)

Rimuove le misurazioni e i dati dell'esperienza utente per un ID di correlazione specificato.

emitEvents(PerformanceEvent[], string)

Genera eventi a tutti i callback registrati.

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Interrompe la misurazione delle prestazioni per un'operazione. Deve essere chiamato direttamente dalle classi PerformanceClient, perché i consumer devono usare invece la funzione restituita da startMeasurement. Aggiunge un nuovo campo denominato "[nome evento]DurationMs" per le misurazioni secondarie, completa e genera un evento in caso contrario.

getPreQueueTime(string, string)

Ottiene la mappa dei tempi di pre-coda in base all'ID di correlazione

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

Contatori di incremento da generare quando le misurazioni vengono scaricate

removePerformanceCallback(string)

Rimuove un callback registrato con addPerformanceCallback.

startPerformanceMeasurement(string, string)

Avvia e restituisce un'implementazione specifica della piattaforma di IPerformanceMeasurement. Nota: questa funzione può essere modificata in modo da astrarre al successivo urto della versione principale.

Dettagli costruttore

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

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

Parametri

configuration
Configuration
intFields

Set<string>

abbreviations

Map<string, string>

Dettagli metodo

addQueueMeasurement(string, string, number, boolean)

Calcola e aggiunge la misurazione del tempo della coda per un determinato evento di prestazioni.

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

Parametri

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indicatore per le misurazioni della coda completate manualmente

generateId()

function generateId(): string

Valori restituiti

string

setPreQueueTime(PerformanceEvents, string)

Aggiunge il tempo di pre-coda alla mappa preQueueTimeByCorrelationId.

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

Parametri

eventName
PerformanceEvents
correlationId

string

startMeasurement(string, string)

Avvia la misurazione delle prestazioni per una determinata operazione. Restituisce una funzione che deve essere utilizzata per terminare la misurazione. Acquisisce anche visibilityState della pagina del browser.

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

Parametri

measureName

string

correlationId

string

Valori restituiti

Dettagli dei metodi ereditati

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

Salva informazioni aggiuntive da generare quando le misurazioni vengono scaricate

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

Parametri

fields

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

correlationId

string

Ereditato da PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Registra una funzione di callback per ricevere eventi di prestazioni.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametri

Valori restituiti

string

Ereditato da PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Calcola la differenza tra l'ora corrente e l'ora in cui è stata accodata la funzione. Nota: è possibile avere 0 come ora della coda se l'ora corrente e l'ora in coda erano uguali.

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

Parametri

preQueueTime

number

currentTime

number

Valori restituiti

number

Ereditato da PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Rimuove le misurazioni e i dati dell'esperienza utente per un ID di correlazione specificato.

function discardMeasurements(correlationId: string)

Parametri

correlationId

string

Ereditato da PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Genera eventi a tutti i callback registrati.

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

Parametri

events

PerformanceEvent[]

correlationId

string

Ereditato da PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Interrompe la misurazione delle prestazioni per un'operazione. Deve essere chiamato direttamente dalle classi PerformanceClient, perché i consumer devono usare invece la funzione restituita da startMeasurement. Aggiunge un nuovo campo denominato "[nome evento]DurationMs" per le misurazioni secondarie, completa e genera un evento in caso contrario.

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

Parametri

error

unknown

account
AccountInfo

Valori restituiti

Ereditato da PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Ottiene la mappa dei tempi di pre-coda in base all'ID di correlazione

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

Parametri

eventName

string

correlationId

string

Valori restituiti

number | void

Ereditato da PerformanceClient.getPreQueueTime

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

Contatori di incremento da generare quando le misurazioni vengono scaricate

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

Parametri

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identificatore di correlazione {string}

Ereditato da PerformanceClient.incrementFields

removePerformanceCallback(string)

Rimuove un callback registrato con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametri

callbackId

string

Valori restituiti

boolean

Ereditato da PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Avviso

Questa API è ora deprecata.

This method will be removed in the next major version

Avvia e restituisce un'implementazione specifica della piattaforma di IPerformanceMeasurement. Nota: questa funzione può essere modificata in modo da astrarre al successivo urto della versione principale.

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

Parametri

measureName

string

correlationId

string

Valori restituiti

Ereditato da PerformanceClient.startPerformanceMeasurement