PerformanceClient class

Crea una instancia de PerformanceClient, una clase abstracta que contiene la lógica de telemetría de rendimiento principal.

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

Parámetros

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

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

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parámetros

Devoluciones

Agrega el tiempo de medición de cola a la matriz QueueMeasurements para el identificador de correlación especificado.

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

Parámetros

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

Devoluciones

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

function discardMeasurements(correlationId: string)

Parámetros

Emite eventos a todas las devoluciones de llamada registradas.

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

Parámetros

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

Devoluciones

Genera y devuelve un identificador único, normalmente un guid.

function generateId(): string

Devoluciones

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

Devoluciones

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

Quita una devolución de llamada registrada con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parámetros

Devoluciones

Establece el tiempo previo a la cola por identificador de correlación

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

Parámetros

Comienza a medir el rendimiento de una operación determinada. Devuelve una función que se debe usar para finalizar la medida.

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

Parámetros

Devoluciones

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

Devoluciones