BrowserPerformanceClient class

Пакет:

@azure/msal-browser

Extends

PerformanceClient

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

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

Методы

addQueueMeasurement(string, string, number, boolean)	Вычисляет и добавляет измерение времени очереди для данного события производительности.
generateId()
setPreQueueTime(PerformanceEvents, string)	Добавляет время предварительной очереди на карту preQueueTimeByCorrelationId.
startMeasurement(string, string)	Начинает измерять производительность для данной операции. Возвращает функцию, которая должна использоваться для завершения измерения. Также фиксирует видимость страницы браузера.

Наследуемые методы

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

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

BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)

new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)

Параметры

configuration

Configuration

intFields

Set<string>

abbreviations

Map<string, string>

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

addQueueMeasurement(string, string, number, boolean)

Вычисляет и добавляет измерение времени очереди для данного события производительности.

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

Параметры

eventName

string

correlationId

string

queueTime

number

manuallyCompleted

boolean

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

generateId()

function generateId(): string

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

string

setPreQueueTime(PerformanceEvents, string)

Добавляет время предварительной очереди на карту preQueueTimeByCorrelationId.

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

Сведения о наследуемом методе

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

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

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

Параметры

fields

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

correlationId

string

Наследуется от PerformanceClient.addFields

addPerformanceCallback(PerformanceCallbackFunction)

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

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Параметры

callback

PerformanceCallbackFunction

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

string

Наследуется от PerformanceClient.addPerformanceCallback

calculateQueuedTime(number, number)

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

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

Параметры

preQueueTime

number

currentTime

number

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

number

Наследуется от PerformanceClient.calculateQueuedTime

discardMeasurements(string)

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

function discardMeasurements(correlationId: string)

Параметры

correlationId

string

Наследуется от PerformanceClient.discardMeasurements

emitEvents(PerformanceEvent[], string)

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

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

Параметры

events

PerformanceEvent[]

correlationId

string

Наследуется от PerformanceClient.emitEvents

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

Наследуется от PerformanceClient.endMeasurement

getPreQueueTime(string, string)

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

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

Параметры

eventName

string

correlationId

string

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

number | void

Наследуется от PerformanceClient.getPreQueueTime

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

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

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

Параметры

fields

{[key: string]: number | undefined}

{string[]}

correlationId

string

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

Наследуется от PerformanceClient.incrementFields

removePerformanceCallback(string)

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

function removePerformanceCallback(callbackId: string): boolean

Параметры

callbackId

string

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

boolean

Наследуется от PerformanceClient.removePerformanceCallback

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

Наследуется от PerformanceClient.startPerformanceMeasurement