BrowserPerformanceClient class

Extends

Métodos

addQueueMeasurement(string, string, number, boolean)

Calcula e adiciona a medição do tempo de fila para um determinado evento de desempenho.

generateId()
setPreQueueTime(PerformanceEvents, string)

Adiciona tempo de pré-fila ao mapa preQueueTimeByCorrelationId.

startMeasurement(string, string)

Começa a medir o desempenho de uma determinada operação. Devolve uma função que deve ser usada para terminar a medição. Também capta a visibilidade da página do navegador. Estado.

Métodos Herdados

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

Poupa informação extra quando as medições são limpas

addPerformanceCallback(PerformanceCallbackFunction)

Regista uma função de callback para receber eventos de performance.

calculateQueuedTime(number, number)

Calcula a diferença entre a hora atual e a hora em que a função foi colocada na fila. Nota: É possível ter 0 como tempo de fila se o tempo atual e o tempo de espera forem iguais.

discardMeasurements(string)

Remove medições e dados auxiliares para um dado id de correlação.

emitEvents(PerformanceEvent[], string)

Emite eventos para todos os callbacks registados.

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Deixa de medir o desempenho de uma operação. Deve ser chamada diretamente apenas pelas classes PerformanceClient, pois os consumidores devem usar a função devolvida por startMeasurement. Adiciona um novo campo chamado "[nome do evento]DurationMs" para submedições, completa e emite um evento caso contrário.

getPreQueueTime(string, string)

Obtém o mapa dos tempos de pré-fila por correlação Id

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

Contadores de incremento a serem emitidos quando as medições são lavadas

removePerformanceCallback(string)

Remove um callback registado com o addPerformanceCallback.

startPerformanceMeasurement(string, string)

Inicia e retorna uma implementação específica da plataforma do IPerformanceMeasurement. Nota: esta função pode ser alterada para abstraída na próxima grande atualização da versão.

Detalhes do Construtor

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>

Detalhes de Método

addQueueMeasurement(string, string, number, boolean)

Calcula e adiciona a medição do tempo de fila para um determinado evento de desempenho.

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

Parâmetros

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indicador para medições de fila preencaminhadas manualmente

generateId()

function generateId(): string

Devoluções

string

setPreQueueTime(PerformanceEvents, string)

Adiciona tempo de pré-fila ao mapa preQueueTimeByCorrelationId.

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

Parâmetros

eventName
PerformanceEvents
correlationId

string

startMeasurement(string, string)

Começa a medir o desempenho de uma determinada operação. Devolve uma função que deve ser usada para terminar a medição. Também capta a visibilidade da página do navegador. Estado.

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

Parâmetros

measureName

string

correlationId

string

Devoluções

Detalhes do Método Herdado

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

Poupa informação extra quando as medições são limpas

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

Parâmetros

fields

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

correlationId

string

Herdado de PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

Regista uma função de callback para receber eventos de performance.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parâmetros

Devoluções

string

Herdado de PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

Calcula a diferença entre a hora atual e a hora em que a função foi colocada na fila. Nota: É possível ter 0 como tempo de fila se o tempo atual e o tempo de espera forem iguais.

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

Parâmetros

preQueueTime

number

currentTime

number

Devoluções

number

Herdado de PerformanceClient.calculateQueuedTimeTime

discardMeasurements(string)

Remove medições e dados auxiliares para um dado id de correlação.

function discardMeasurements(correlationId: string)

Parâmetros

correlationId

string

Herdado de PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

Emite eventos para todos os callbacks registados.

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

Parâmetros

events

PerformanceEvent[]

correlationId

string

Herdado de PerformanceClient.emitEvents

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Deixa de medir o desempenho de uma operação. Deve ser chamada diretamente apenas pelas classes PerformanceClient, pois os consumidores devem usar a função devolvida por startMeasurement. Adiciona um novo campo chamado "[nome do evento]DurationMs" para submedições, completa e emite um evento caso contrário.

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

Parâmetros

error

unknown

account
AccountInfo

Devoluções

Herdado de PerformanceClient.endMeasurement

getPreQueueTime(string, string)

Obtém o mapa dos tempos de pré-fila por correlação Id

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

Parâmetros

eventName

string

correlationId

string

Devoluções

number | void

Herdado de PerformanceClient.getPreQueueTime

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

Contadores de incremento a serem emitidos quando as medições são lavadas

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

Parâmetros

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

{string} identificador de correlação

Herdado de PerformanceClient.incrementFields

removePerformanceCallback(string)

Remove um callback registado com o addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parâmetros

callbackId

string

Devoluções

boolean

Herdado de PerformanceClient.removePerformanceCallback

startPerformanceMeasurement(string, string)

Aviso

Esta API foi preterida.

This method will be removed in the next major version

Inicia e retorna uma implementação específica da plataforma do IPerformanceMeasurement. Nota: esta função pode ser alterada para abstraída na próxima grande atualização da versão.

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

Parâmetros

measureName

string

correlationId

string

Devoluções

Herdado de PerformanceClient.startPerformancePerformanceMeasurement