PerformanceClient class

Paket:

@azure/msal-common

Oluşturucular

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

Çekirdek performans telemetri mantığı içeren soyut bir sınıf olan PerformanceClient örneğini oluşturur.

Yöntemler

addFields({[key: string]: {} | undefined}, string)	Ölçümler boşaltıldığında yayılacak ek bilgileri kaydeder
addPerformanceCallback(PerformanceCallbackFunction)	Performans olaylarını almak için geri çağırma işlevini kaydeder.
addQueueMeasurement(string, string, number, boolean)	Verilen bağıntı kimliği için QueueMeasurements dizisine kuyruk ölçüm süresi ekler.
calculateQueuedTime(number, number)	İşlevin kuyruğa alındığı zaman ile saat arasındaki farkı hesaplar. Not: Geçerli saat ve kuyruğa alınan saat aynıysa kuyruk süresi olarak 0 olması mümkündür.
discardMeasurements(string)	Belirli bir bağıntı kimliği için ölçümleri ve yedek verileri kaldırır.
emitEvents(PerformanceEvent[], string)	Olayları tüm kayıtlı geri çağırmalara yayar.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Bir işlemin performansını ölçmeyi durdurur. Tüketicilerin startMeasurement tarafından döndürülen işlevi kullanması gerektiği için yalnızca doğrudan PerformanceClient sınıfları tarafından çağrılmalıdır. Alt ölçümler için "[olay adı]DurationMs" adlı yeni bir alan ekler, tamamlar ve aksi takdirde bir olay yayar.
generateId()	Genellikle guid olan benzersiz bir kimlik oluşturur ve döndürür.
getPreQueueTime(string, string)	Bağıntı kimliğine göre kuyruk öncesi zamanların haritasını alır
incrementFields({[key: string]: number | undefined}, string)	Ölçümler boşaltıldığında yayılacak artım sayaçları
removePerformanceCallback(string)	addPerformanceCallback ile kaydedilen bir geri çağırmayı kaldırır.
setPreQueueTime(PerformanceEvents, string)	Kuyruk öncesi süreyi bağıntı kimliğine göre ayarlar
startMeasurement(string, string)	Belirli bir işlemin performansını ölçmeye başlar. Ölçümü sonlandırmak için kullanılması gereken bir işlev döndürür.
startPerformanceMeasurement(string, string)	IPerformanceMeasurement'ın platforma özgü uygulamasını başlatır ve döndürür. Not: Bu işlev, bir sonraki ana sürüm tümsekinde soyut olacak şekilde değiştirilebilir.

Oluşturucu Ayrıntıları

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

Çekirdek performans telemetri mantığı içeren soyut bir sınıf olan PerformanceClient örneğini oluşturur.

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

Parametreler

clientId

string

Uygulamanın istemci kimliği

authority

string

Uygulama tarafından kullanılan yetkili

logger

Logger

Uygulama tarafından kullanılan günlükçü

libraryName

string

Kitaplığın adı

libraryVersion

string

Kitaplığın sürümü

applicationTelemetry

ApplicationTelemetry

uygulama adı ve sürümü

intFields

Set<string>

kesilecek tamsayı alanları

abbreviations

Map<string, string>

olay adı kısaltmaları

Yöntem Ayrıntıları

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

Ölçümler boşaltıldığında yayılacak ek bilgileri kaydeder

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

Parametreler

fields

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

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction)

Performans olaylarını almak için geri çağırma işlevini kaydeder.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametreler

callback

PerformanceCallbackFunction

Döndürülenler

string

addQueueMeasurement(string, string, number, boolean)

Verilen bağıntı kimliği için QueueMeasurements dizisine kuyruk ölçüm süresi ekler.

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

Parametreler

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

el ile tamamlanan kuyruk ölçümleri göstergesi

calculateQueuedTime(number, number)

İşlevin kuyruğa alındığı zaman ile saat arasındaki farkı hesaplar. Not: Geçerli saat ve kuyruğa alınan saat aynıysa kuyruk süresi olarak 0 olması mümkündür.

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

Parametreler

preQueueTime

number

currentTime

number

Döndürülenler

number

discardMeasurements(string)

Belirli bir bağıntı kimliği için ölçümleri ve yedek verileri kaldırır.

function discardMeasurements(correlationId: string)

Parametreler

correlationId

string

emitEvents(PerformanceEvent[], string)

Olayları tüm kayıtlı geri çağırmalara yayar.

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

Parametreler

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Bir işlemin performansını ölçmeyi durdurur. Tüketicilerin startMeasurement tarafından döndürülen işlevi kullanması gerektiği için yalnızca doğrudan PerformanceClient sınıfları tarafından çağrılmalıdır. Alt ölçümler için "[olay adı]DurationMs" adlı yeni bir alan ekler, tamamlar ve aksi takdirde bir olay yayar.

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

Parametreler

event

PerformanceEvent

error

unknown

account

AccountInfo

Döndürülenler

null | PerformanceEvent

generateId()

Genellikle guid olan benzersiz bir kimlik oluşturur ve döndürür.

function generateId(): string

Döndürülenler

string

getPreQueueTime(string, string)

Bağıntı kimliğine göre kuyruk öncesi zamanların haritasını alır

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

Parametreler

eventName

string

correlationId

string

Döndürülenler

number | void

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

Ölçümler boşaltıldığında yayılacak artım sayaçları

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

Parametreler

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

{string} bağıntı tanımlayıcısı

removePerformanceCallback(string)

addPerformanceCallback ile kaydedilen bir geri çağırmayı kaldırır.

function removePerformanceCallback(callbackId: string): boolean

Parametreler

callbackId

string

Döndürülenler

boolean

setPreQueueTime(PerformanceEvents, string)

Kuyruk öncesi süreyi bağıntı kimliğine göre ayarlar

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

Parametreler

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Belirli bir işlemin performansını ölçmeye başlar. Ölçümü sonlandırmak için kullanılması gereken bir işlev döndürür.

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

Parametreler

measureName

string

correlationId

string

Döndürülenler

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

Uyarı

Bu API artık kullanım dışıdır.

This method will be removed in the next major version

IPerformanceMeasurement'ın platforma özgü uygulamasını başlatır ve döndürür. Not: Bu işlev, bir sonraki ana sürüm tümsekinde soyut olacak şekilde değiştirilebilir.

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

Parametreler

measureName

string

correlationId

string

Döndürülenler

IPerformanceMeasurement