BrowserPerformanceClient class

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

Parameters

Calculates and adds queue time measurement for given performance event.

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

Parameters

function generateId(): string

Returns

Adds pre-queue time to preQueueTimeByCorrelationId map.

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

Parameters

Starts measuring performance for a given operation. Returns a function that should be used to end the measurement. Also captures browser page visibilityState.

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

Parameters

Returns

Saves extra information to be emitted when the measurements are flushed

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

Parameters

Inherited From PerformanceClient.addFields

Registers a callback function to receive performance events.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Returns

Inherited From PerformanceClient.addPerformanceCallback

Calculates the difference between current time and time when function was queued. Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.

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

Parameters

Returns

Inherited From PerformanceClient.calculateQueuedTime

Removes measurements and aux data for a given correlation id.

function discardMeasurements(correlationId: string)

Parameters

Inherited From PerformanceClient.discardMeasurements

Emits events to all registered callbacks.

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

Parameters

Inherited From PerformanceClient.emitEvents

Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes, as consumers should instead use the function returned by startMeasurement. Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event otherwise.

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

Parameters

Returns

Inherited From PerformanceClient.endMeasurement

Gets map of pre-queue times by correlation Id

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

Parameters

Returns

Inherited From PerformanceClient.getPreQueueTime

Increment counters to be emitted when the measurements are flushed

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

Parameters

Inherited From PerformanceClient.incrementFields

Removes a callback registered with addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameters

Returns

Inherited From PerformanceClient.removePerformanceCallback

Starts and returns an platform-specific implementation of IPerformanceMeasurement. Note: this function can be changed to abstract at the next major version bump.

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

Parameters

Returns

Inherited From PerformanceClient.startPerformanceMeasurement