PerformanceClient class

Construtores

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

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

Métodos

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

Salva informações extras a serem emitidas quando as medidas são liberadas

addPerformanceCallback(PerformanceCallbackFunction)

Registra uma função de retorno de chamada para receber eventos de desempenho.

addQueueMeasurement(string, string, number, boolean)

Adiciona tempo de medição de fila à matriz QueueMeasurements para determinada ID de correlação.

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.

discardMeasurements(string)

Remove medidas e dados de aux para uma determinada ID de correlação.

emitEvents(PerformanceEvent[], string)

Emite eventos para todos os retornos de chamada registrados.

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 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.

generateId()

Gera e retorna uma ID exclusiva, normalmente um guid.

getPreQueueTime(string, string)

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

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

Contadores de incremento a serem emitidos quando as medidas são liberadas

removePerformanceCallback(string)

Remove um retorno de chamada registrado com addPerformanceCallback.

setPreQueueTime(PerformanceEvents, string)

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

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.

startPerformanceMeasurement(string, string)

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

PerformanceClient(string, string, Logger, string, string, ApplicationTelemetry, Set<string>, Map<string, string>)

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

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

Parâmetros

clientId

string

ID do cliente do aplicativo

authority

string

Autoridade usada pelo aplicativo

logger
Logger

Agente usado pelo aplicativo

libraryName

string

O nome da biblioteca

libraryVersion

string

Versão da biblioteca

applicationTelemetry
ApplicationTelemetry

nome e versão do aplicativo

intFields

Set<string>

campos inteiros a serem truncados

abbreviations

Map<string, string>

abreviações de nome do evento

Detalhes do método

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

addPerformanceCallback(PerformanceCallbackFunction)

Registra uma função de retorno de chamada para receber eventos de desempenho.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parâmetros

Retornos

string

addQueueMeasurement(string, string, number, boolean)

Adiciona tempo de medição de fila à matriz QueueMeasurements para determinada ID de correlação.

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

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

discardMeasurements(string)

Remove medidas e dados de aux para uma determinada ID de correlação.

function discardMeasurements(correlationId: string)

Parâmetros

correlationId

string

emitEvents(PerformanceEvent[], string)

Emite eventos para todos os retornos de chamada registrados.

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

Parâmetros

events

PerformanceEvent[]

correlationId

string

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 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

error

unknown

account
AccountInfo

Retornos

generateId()

Gera e retorna uma ID exclusiva, normalmente um guid.

function generateId(): string

Retornos

string

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

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}

removePerformanceCallback(string)

Remove um retorno de chamada registrado com addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parâmetros

callbackId

string

Retornos

boolean

setPreQueueTime(PerformanceEvents, string)

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

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.

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

Parâmetros

measureName

string

correlationId

string

Retornos

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