PerformanceClient class

Cria uma instância do PerformanceClient, uma classe abstrata que contém lógica central de telemetria de desempenho.

new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>, abbreviations?: Map<string, string>)

Parâmetros

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

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

Parâmetros

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

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parâmetros

Devoluções

Adiciona tempo de medição da fila ao array QueueMeasurements para o ID de correlação dado.

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

Parâmetros

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

Devoluções

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

function discardMeasurements(correlationId: string)

Parâmetros

Emite eventos para todos os callbacks registados.

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

Parâmetros

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

Devoluções

Gera e devolve um id único, tipicamente um guid.

function generateId(): string

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Remove um callback registado com o addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parâmetros

Devoluções

Define o tempo de pré-fila por correlação Id

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

Parâmetros

Começa a medir o desempenho de uma determinada operação. Devolve uma função que deve ser usada para terminar a medição.

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

Parâmetros

Devoluções

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

Devoluções