BrowserPerformanceClient class

Extends

Métodos

addQueueMeasurement(string, string, number, boolean)

Calcula y agrega una medida de tiempo de cola para un evento de rendimiento determinado.

generateId()
setPreQueueTime(PerformanceEvents, string)

Agrega tiempo de cola previa a la asignación preQueueTimeByCorrelationId.

startMeasurement(string, string)

Comienza a medir el rendimiento de una operación determinada. Devuelve una función que se debe usar para finalizar la medida. También captura visibilityState de la página del explorador.

Métodos heredados

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

Guarda información adicional que se va a emitir cuando se vacían las medidas.

addPerformanceCallback(PerformanceCallbackFunction)

Registra una función de devolución de llamada para recibir eventos de rendimiento.

calculateQueuedTime(number, number)

Calcula la diferencia entre la hora actual y la hora en que se puso en cola la función. Nota: Es posible tener 0 como tiempo de cola si la hora actual y la hora en cola eran iguales.

discardMeasurements(string)

Quita las medidas y los datos auxiliares de un identificador de correlación determinado.

emitEvents(PerformanceEvent[], string)

Emite eventos a todas las devoluciones de llamada registradas.

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Detiene la medición del rendimiento de una operación. Las clases PerformanceClient solo deben llamarlas directamente, ya que los consumidores deben usar la función devuelta por startMeasurement. Agrega un nuevo campo denominado "[nombre de evento]DurationMs" para las subtareas, completa y emite un evento de lo contrario.

getPreQueueTime(string, string)

Obtiene el mapa de los tiempos previos a la cola por identificador de correlación.

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

Contadores de incremento que se van a emitir cuando se vacían las medidas

removePerformanceCallback(string)

Quita una devolución de llamada registrada con addPerformanceCallback.

startPerformanceMeasurement(string, string)

Inicia y devuelve una implementación específica de la plataforma de IPerformanceMeasurement. Nota: esta función se puede cambiar para que se abstraa en el siguiente salto de versión principal.

Detalles del constructor

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

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

Parámetros

configuration
Configuration
intFields

Set<string>

abbreviations

Map<string, string>

Detalles del método

addQueueMeasurement(string, string, number, boolean)

Calcula y agrega una medida de tiempo de cola para un evento de rendimiento determinado.

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

Parámetros

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indicador de medidas de cola completadas manualmente

generateId()

function generateId(): string

Devoluciones

string

setPreQueueTime(PerformanceEvents, string)

Agrega tiempo de cola previa a la asignación preQueueTimeByCorrelationId.

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

Parámetros

eventName
PerformanceEvents
correlationId

string

startMeasurement(string, string)

Comienza a medir el rendimiento de una operación determinada. Devuelve una función que se debe usar para finalizar la medida. También captura visibilityState de la página del explorador.

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

Parámetros

measureName

string

correlationId

string

Devoluciones

Detalles de los métodos heredados

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

Guarda información adicional que se va a emitir cuando se vacían las medidas.

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

Parámetros

fields

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

correlationId

string

Heredado de PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Registra una función de devolución de llamada para recibir eventos de rendimiento.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parámetros

Devoluciones

string

Heredado de PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Calcula la diferencia entre la hora actual y la hora en que se puso en cola la función. Nota: Es posible tener 0 como tiempo de cola si la hora actual y la hora en cola eran iguales.

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

Parámetros

preQueueTime

number

currentTime

number

Devoluciones

number

Heredado de PerformanceClient.calculateQueuedTime

discardMeasurements(string)

Quita las medidas y los datos auxiliares de un identificador de correlación determinado.

function discardMeasurements(correlationId: string)

Parámetros

correlationId

string

Heredado de PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Emite eventos a todas las devoluciones de llamada registradas.

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

Parámetros

events

PerformanceEvent[]

correlationId

string

Heredado de PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Detiene la medición del rendimiento de una operación. Las clases PerformanceClient solo deben llamarlas directamente, ya que los consumidores deben usar la función devuelta por startMeasurement. Agrega un nuevo campo denominado "[nombre de evento]DurationMs" para las subtareas, completa y emite un evento de lo contrario.

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

Parámetros

error

unknown

account
AccountInfo

Devoluciones

Heredado de PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Obtiene el mapa de los tiempos previos a la cola por identificador de correlación.

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

Parámetros

eventName

string

correlationId

string

Devoluciones

number | void

Heredado de PerformanceClient.getPreQueueTime

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

Contadores de incremento que se van a emitir cuando se vacían las medidas

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

Parámetros

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Identificador de correlación de {string}

Heredado de PerformanceClient.incrementFields

removePerformanceCallback(string)

Quita una devolución de llamada registrada con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parámetros

callbackId

string

Devoluciones

boolean

Heredado de PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Advertencia

Esta API ya está en desuso.

This method will be removed in the next major version

Inicia y devuelve una implementación específica de la plataforma de IPerformanceMeasurement. Nota: esta función se puede cambiar para que se abstraa en el siguiente salto de versión principal.

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

Parámetros

measureName

string

correlationId

string

Devoluciones

Heredado de PerformanceClient.startPerformanceMeasurement