PerformanceClient class

Paket:

@azure/msal-common

Konstruktor

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

Membuat instans PerformanceClient, kelas abstrak yang berisi logika telemetri performa inti.

Metode

addFields({[key: string]: {} | undefined}, string)	Menyimpan informasi tambahan yang akan dipancarkan ketika pengukuran dihapus
addPerformanceCallback(PerformanceCallbackFunction)	Mendaftarkan fungsi panggilan balik untuk menerima peristiwa performa.
addQueueMeasurement(string, string, number, boolean)	Menambahkan waktu pengukuran antrean ke array QueueMeasurements untuk ID korelasi tertentu.
calculateQueuedTime(number, number)	Menghitung perbedaan antara waktu dan waktu saat ini ketika fungsi diantrekan. Catatan: Dimungkinkan untuk memiliki 0 sebagai waktu antrean jika waktu saat ini dan waktu antrean sama.
discardMeasurements(string)	Menghapus pengukuran dan data aux untuk id korelasi tertentu.
emitEvents(PerformanceEvent[], string)	Memancarkan peristiwa ke semua panggilan balik terdaftar.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Berhenti mengukur performa untuk operasi. Hanya boleh dipanggil langsung oleh kelas PerformanceClient, karena konsumen harus menggunakan fungsi yang dikembalikan oleh startMeasurement. Menambahkan bidang baru bernama "[nama peristiwa]DurationMs" untuk sub-pengukuran, menyelesaikan, dan memancarkan peristiwa jika tidak.
generateId()	Menghasilkan dan mengembalikan id unik, biasanya guid.
getPreQueueTime(string, string)	Mendapatkan peta waktu pra-antrean dengan Id korelasi
incrementFields({[key: string]: number | undefined}, string)	Penghitung kenaikan yang akan dipancarkan ketika pengukuran dibuang
removePerformanceCallback(string)	Menghapus panggilan balik yang terdaftar dengan addPerformanceCallback.
setPreQueueTime(PerformanceEvents, string)	Mengatur waktu pra-antrean menurut ID korelasi
startMeasurement(string, string)	Mulai mengukur performa untuk operasi tertentu. Mengembalikan fungsi yang harus digunakan untuk mengakhiri pengukuran.
startPerformanceMeasurement(string, string)	Memulai dan mengembalikan implementasi IPerformanceMeasurement khusus platform. Catatan: fungsi ini dapat diubah menjadi abstrak pada benjolan versi utama berikutnya.

Detail Konstruktor

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

Membuat instans PerformanceClient, kelas abstrak yang berisi logika telemetri performa inti.

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

Parameter

clientId

string

ID klien aplikasi

authority

string

Otoritas yang digunakan oleh aplikasi

logger

Logger

Pencatat yang digunakan oleh aplikasi

libraryName

string

Nama perpustakaan

libraryVersion

string

Versi pustaka

applicationTelemetry

ApplicationTelemetry

nama dan versi aplikasi

intFields

Set<string>

bidang bilangan bulat yang akan dipotong

abbreviations

Map<string, string>

singkatan nama peristiwa

Detail Metode

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

Menyimpan informasi tambahan yang akan dipancarkan ketika pengukuran dihapus

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

Parameter

fields

{[key: string]: {} | undefined}

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction)

Mendaftarkan fungsi panggilan balik untuk menerima peristiwa performa.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

callback

PerformanceCallbackFunction

Mengembalikan

string

addQueueMeasurement(string, string, number, boolean)

Menambahkan waktu pengukuran antrean ke array QueueMeasurements untuk ID korelasi tertentu.

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

Parameter

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

indikator untuk pengukuran antrean yang diselesaikan secara manual

calculateQueuedTime(number, number)

Menghitung perbedaan antara waktu dan waktu saat ini ketika fungsi diantrekan. Catatan: Dimungkinkan untuk memiliki 0 sebagai waktu antrean jika waktu saat ini dan waktu antrean sama.

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

Parameter

preQueueTime

number

currentTime

number

Mengembalikan

number

discardMeasurements(string)

Menghapus pengukuran dan data aux untuk id korelasi tertentu.

function discardMeasurements(correlationId: string)

Parameter

correlationId

string

emitEvents(PerformanceEvent[], string)

Memancarkan peristiwa ke semua panggilan balik terdaftar.

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

Parameter

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Berhenti mengukur performa untuk operasi. Hanya boleh dipanggil langsung oleh kelas PerformanceClient, karena konsumen harus menggunakan fungsi yang dikembalikan oleh startMeasurement. Menambahkan bidang baru bernama "[nama peristiwa]DurationMs" untuk sub-pengukuran, menyelesaikan, dan memancarkan peristiwa jika tidak.

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

Parameter

event

PerformanceEvent

error

unknown

account

AccountInfo

Mengembalikan

null | PerformanceEvent

generateId()

Menghasilkan dan mengembalikan id unik, biasanya guid.

function generateId(): string

Mengembalikan

string

getPreQueueTime(string, string)

Mendapatkan peta waktu pra-antrean dengan Id korelasi

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

Parameter

eventName

string

correlationId

string

Mengembalikan

number | void

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

Penghitung kenaikan yang akan dipancarkan ketika pengukuran dibuang

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

Parameter

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Pengidentifikasi korelasi {string}

removePerformanceCallback(string)

Menghapus panggilan balik yang terdaftar dengan addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameter

callbackId

string

Mengembalikan

boolean

setPreQueueTime(PerformanceEvents, string)

Mengatur waktu pra-antrean menurut ID korelasi

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

Parameter

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Mulai mengukur performa untuk operasi tertentu. Mengembalikan fungsi yang harus digunakan untuk mengakhiri pengukuran.

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

Parameter

measureName

string

correlationId

string

Mengembalikan

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

Peringatan

API ini sudah tidak digunakan lagi.

This method will be removed in the next major version

Memulai dan mengembalikan implementasi IPerformanceMeasurement khusus platform. Catatan: fungsi ini dapat diubah menjadi abstrak pada benjolan versi utama berikutnya.

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

Parameter

measureName

string

correlationId

string

Mengembalikan

IPerformanceMeasurement