BrowserPerformanceClient class
- Extends
Métodos
| add |
Calcula e adiciona a medida de tempo de fila para determinado evento de desempenho. |
| generate |
|
| set |
Adiciona tempo de pré-fila ao mapa preQueueTimeByCorrelationId. |
| start |
Inicia a medição do desempenho de uma determinada operação. Retorna uma função que deve ser usada para encerrar a medida. Também captura visibilityState da página do navegador. |
Métodos herdados
| add |
Salva informações extras a serem emitidas quando as medidas são liberadas |
| add |
Registra uma função de retorno de chamada para receber eventos de desempenho. |
| calculate |
Calcula a diferença entre a hora atual e a hora em que a função foi enfileirada. Observação: é possível ter 0 como o tempo da fila se a hora atual e a hora da fila forem as mesmas. |
| discard |
Remove medidas e dados de aux para uma determinada ID de correlação. |
| emit |
Emite eventos para todos os retornos de chamada registrados. |
| end |
Para de medir o desempenho de uma operação. Só deve ser chamado diretamente pelas classes PerformanceClient, pois os consumidores devem, em vez disso, usar a função retornada por startMeasurement. Adiciona um novo campo chamado "[nome do evento]DurationMs" para submedimensões, conclui e emite um evento caso contrário. |
| get |
Obtém o mapa de tempos de pré-fila por ID de correlação |
| increment |
Contadores de incremento a serem emitidos quando as medidas são liberadas |
| remove |
Remove um retorno de chamada registrado com addPerformanceCallback. |
| start |
Inicia e retorna uma implementação específica da plataforma de IPerformanceMeasurement. Observação: essa função pode ser alterada para abstrair na próxima colisão de versão principal. |
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 do método
addQueueMeasurement(string, string, number, boolean)
Calcula e adiciona a medida de tempo de fila para 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 de medidas de fila concluídas manualmente
generateId()
function generateId(): string
Retornos
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)
Inicia a medição do desempenho de uma determinada operação. Retorna uma função que deve ser usada para encerrar a medida. Também captura visibilityState da página do navegador.
function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent
Parâmetros
- measureName
-
string
- correlationId
-
string
Retornos
Detalhes do método herdado
addFields({[key: string]: {} | undefined}, string)
Salva informações extras a serem emitidas quando as medidas são liberadas
function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)
Parâmetros
- fields
-
{[key: string]: {} | undefined}
- correlationId
-
string
Herdado de PerformanceClient.addFields
addPerformanceCallback(PerformanceCallbackFunction)
Registra uma função de retorno de chamada para receber eventos de desempenho.
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
Parâmetros
- callback
- PerformanceCallbackFunction
Retornos
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 enfileirada. Observação: é possível ter 0 como o tempo da fila se a hora atual e a hora da fila forem as mesmas.
function calculateQueuedTime(preQueueTime: number, currentTime: number): number
Parâmetros
- preQueueTime
-
number
- currentTime
-
number
Retornos
number
Herdado de PerformanceClient.calculateQueuedTime
discardMeasurements(string)
Remove medidas e dados de aux para uma determinada ID de correlação.
function discardMeasurements(correlationId: string)
Parâmetros
- correlationId
-
string
Herdado de PerformanceClient.discardMeasurements
emitEvents(PerformanceEvent[], string)
Emite eventos para todos os retornos de chamada registrados.
function emitEvents(events: PerformanceEvent[], correlationId?: string)
Parâmetros
- events
- correlationId
-
string
Herdado de PerformanceClient.emitEvents
endMeasurement(PerformanceEvent, unknown, AccountInfo)
Para de medir o desempenho de uma operação. Só deve ser chamado diretamente pelas classes PerformanceClient, pois os consumidores devem, em vez disso, usar a função retornada por startMeasurement. Adiciona um novo campo chamado "[nome do evento]DurationMs" para submedimensões, conclui e emite um evento caso contrário.
function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent
Parâmetros
- event
- PerformanceEvent
- error
-
unknown
- account
- AccountInfo
Retornos
null | PerformanceEvent
Herdado de PerformanceClient.endMeasurement
getPreQueueTime(string, string)
Obtém o mapa de tempos de pré-fila por ID de correlação
function getPreQueueTime(eventName: string, correlationId: string): number | void
Parâmetros
- eventName
-
string
- correlationId
-
string
Retornos
number | void
Herdado de PerformanceClient.getPreQueueTime
incrementFields({[key: string]: number | undefined}, string)
Contadores de incremento a serem emitidos quando as medidas são liberadas
function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)
Parâmetros
- fields
-
{[key: string]: number | undefined}
{string[]}
- correlationId
-
string
Identificador de correlação {string}
Herdado de PerformanceClient.incrementFields
removePerformanceCallback(string)
Remove um retorno de chamada registrado com addPerformanceCallback.
function removePerformanceCallback(callbackId: string): boolean
Parâmetros
- callbackId
-
string
Retornos
boolean
Herdado de PerformanceClient.removePerformanceCallback
startPerformanceMeasurement(string, string)
Aviso
Essa API foi preterida.
This method will be removed in the next major version
Inicia e retorna uma implementação específica da plataforma de IPerformanceMeasurement. Observação: essa função pode ser alterada para abstrair na próxima colisão de versão principal.
function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement
Parâmetros
- measureName
-
string
- correlationId
-
string
Retornos
Herdado de PerformanceClient.startPerformanceMeasurement