PerformanceClient class

Crea un'istanza di PerformanceClient, una classe astratta contenente la logica di telemetria delle prestazioni di base.

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

Parametri

Salva informazioni aggiuntive da generare quando le misurazioni vengono scaricate

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

Parametri

Registra una funzione di callback per ricevere eventi di prestazioni.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametri

Valori restituiti

Aggiunge il tempo di misurazione della coda alla matrice QueueMeasurements per l'ID di correlazione specificato.

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

Parametri

Calcola la differenza tra l'ora corrente e l'ora in cui è stata accodata la funzione. Nota: è possibile avere 0 come ora della coda se l'ora corrente e l'ora in coda erano uguali.

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

Parametri

Valori restituiti

Rimuove le misurazioni e i dati dell'esperienza utente per un ID di correlazione specificato.

function discardMeasurements(correlationId: string)

Parametri

Genera eventi a tutti i callback registrati.

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

Parametri

Interrompe la misurazione delle prestazioni per un'operazione. Deve essere chiamato direttamente dalle classi PerformanceClient, perché i consumer devono usare invece la funzione restituita da startMeasurement. Aggiunge un nuovo campo denominato "[nome evento]DurationMs" per le misurazioni secondarie, completa e genera un evento in caso contrario.

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

Parametri

Valori restituiti

Genera e restituisce un ID univoco, in genere un GUID.

function generateId(): string

Valori restituiti

Ottiene la mappa dei tempi di pre-coda in base all'ID di correlazione

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

Parametri

Valori restituiti

Contatori di incremento da generare quando le misurazioni vengono scaricate

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

Parametri

Rimuove un callback registrato con addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametri

Valori restituiti

Imposta il tempo di pre-coda in base all'ID correlazione

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

Parametri

Avvia la misurazione delle prestazioni per una determinata operazione. Restituisce una funzione che deve essere utilizzata per terminare la misurazione.

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

Parametri

Valori restituiti

Avvia e restituisce un'implementazione specifica della piattaforma di IPerformanceMeasurement. Nota: questa funzione può essere modificata in modo da astrarre al successivo urto della versione principale.

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

Parametri

Valori restituiti