PerformanceClient class

Пакет:

@azure/msal-common

Конструкторы

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

Создает экземпляр PerformanceClient, абстрактный класс, содержащий основную логику телеметрии производительности.

Методы

addFields({[key: string]: {} | undefined}, string)	Сохраняет дополнительные сведения при очистке измерений
addPerformanceCallback(PerformanceCallbackFunction)	Регистрирует функцию обратного вызова для получения событий производительности.
addQueueMeasurement(string, string, number, boolean)	Добавляет время измерения очереди в массив QueueMeasurements для заданного идентификатора корреляции.
calculateQueuedTime(number, number)	Вычисляет разницу между текущим временем и временем, когда функция была поставлена в очередь. Примечание. Можно иметь значение 0 в качестве времени очереди, если текущее время и время в очереди совпадало.
discardMeasurements(string)	Удаляет измерения и данные о aux для заданного идентификатора корреляции.
emitEvents(PerformanceEvent[], string)	Выдает события для всех зарегистрированных обратных вызовов.
endMeasurement(PerformanceEvent, unknown, AccountInfo)	Останавливает измерение производительности операции. Следует вызывать только непосредственно классами PerformanceClient, так как потребители вместо этого должны использовать функцию, возвращаемую startMeasurement. Добавляет новое поле с именем "[имя события]DurationMs" для вложенных измерений, завершает и выдает событие в противном случае.
generateId()	Создает и возвращает уникальный идентификатор, обычно guid.
getPreQueueTime(string, string)	Получает карту времени предварительной очереди по идентификатору корреляции
incrementFields({[key: string]: number | undefined}, string)	Счетчики добавок, которые следует выдавать при очистке измерений
removePerformanceCallback(string)	Удаляет обратный вызов, зарегистрированный с помощью addPerformanceCallback.
setPreQueueTime(PerformanceEvents, string)	Задает время предварительной очереди по идентификатору корреляции
startMeasurement(string, string)	Начинает измерять производительность для данной операции. Возвращает функцию, которая должна использоваться для завершения измерения.
startPerformanceMeasurement(string, string)	Запускает и возвращает конкретную платформу реализацию IPerformanceMeasurement. Примечание. Эта функция может быть изменена на абстрактную на следующую основную версию.

Сведения о конструкторе

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

Создает экземпляр PerformanceClient, абстрактный класс, содержащий основную логику телеметрии производительности.

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

Параметры

clientId

string

Идентификатор клиента приложения

authority

string

Центр, используемый приложением

logger

Logger

Средство ведения журнала, используемое приложением

libraryName

string

Имя библиотеки

libraryVersion

string

Версия библиотеки

applicationTelemetry

ApplicationTelemetry

имя и версия приложения

intFields

Set<string>

Целочисленные поля для усечения

abbreviations

Map<string, string>

Сокращенные имена событий

Сведения о методе

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

Сохраняет дополнительные сведения при очистке измерений

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

Параметры

fields

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

correlationId

string

addPerformanceCallback(PerformanceCallbackFunction)

Регистрирует функцию обратного вызова для получения событий производительности.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Параметры

callback

PerformanceCallbackFunction

Возвращаемое значение

string

addQueueMeasurement(string, string, number, boolean)

Добавляет время измерения очереди в массив QueueMeasurements для заданного идентификатора корреляции.

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

Параметры

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

индикатор для измерений очереди вручную

calculateQueuedTime(number, number)

Вычисляет разницу между текущим временем и временем, когда функция была поставлена в очередь. Примечание. Можно иметь значение 0 в качестве времени очереди, если текущее время и время в очереди совпадало.

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

Параметры

preQueueTime

number

currentTime

number

Возвращаемое значение

number

discardMeasurements(string)

Удаляет измерения и данные о aux для заданного идентификатора корреляции.

function discardMeasurements(correlationId: string)

Параметры

correlationId

string

emitEvents(PerformanceEvent[], string)

Выдает события для всех зарегистрированных обратных вызовов.

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

Параметры

events

PerformanceEvent[]

correlationId

string

endMeasurement(PerformanceEvent, unknown, AccountInfo)

Останавливает измерение производительности операции. Следует вызывать только непосредственно классами PerformanceClient, так как потребители вместо этого должны использовать функцию, возвращаемую startMeasurement. Добавляет новое поле с именем "[имя события]DurationMs" для вложенных измерений, завершает и выдает событие в противном случае.

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

Параметры

event

PerformanceEvent

error

unknown

account

AccountInfo

Возвращаемое значение

null | PerformanceEvent

generateId()

Создает и возвращает уникальный идентификатор, обычно guid.

function generateId(): string

Возвращаемое значение

string

getPreQueueTime(string, string)

Получает карту времени предварительной очереди по идентификатору корреляции

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

Параметры

eventName

string

correlationId

string

Возвращаемое значение

number | void

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

Счетчики добавок, которые следует выдавать при очистке измерений

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

Параметры

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

Идентификатор корреляции {string}

removePerformanceCallback(string)

Удаляет обратный вызов, зарегистрированный с помощью addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Параметры

callbackId

string

Возвращаемое значение

boolean

setPreQueueTime(PerformanceEvents, string)

Задает время предварительной очереди по идентификатору корреляции

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

Параметры

eventName

PerformanceEvents

correlationId

string

startMeasurement(string, string)

Начинает измерять производительность для данной операции. Возвращает функцию, которая должна использоваться для завершения измерения.

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

Параметры

measureName

string

correlationId

string

Возвращаемое значение

InProgressPerformanceEvent

startPerformanceMeasurement(string, string)

Предупреждение

Теперь этот API является нерекомендуемым.

This method will be removed in the next major version

Запускает и возвращает конкретную платформу реализацию IPerformanceMeasurement. Примечание. Эта функция может быть изменена на абстрактную на следующую основную версию.

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

Параметры

measureName

string

correlationId

string

Возвращаемое значение

IPerformanceMeasurement