BrowserPerformanceClient class

new BrowserPerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, cryptoOptions: CryptoOptions)

Parameters

function generateId(): string

Returns

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: PerformanceEvents, correlationId?: string): InProgressPerformanceEvent

Parameters

Returns

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

Parameters

Returns

Registers a callback function to receive performance events.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Returns

Inherited From PerformanceClient.addPerformanceCallback

Saves extra information to be emitted when the measurements are flushed

function addStaticFields(fields: StaticFields, correlationId: string)

Parameters

Inherited From PerformanceClient.addStaticFields

Removes measurements 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.

function endMeasurement(event: PerformanceEvent): PerformanceEvent | null

Parameters

Returns

Inherited From PerformanceClient.endMeasurement

Gathers and emits performance events for measurements taked for the given top-level API and correlation ID.

function flushMeasurements(measureName: PerformanceEvents, correlationId: string)

Parameters

Inherited From PerformanceClient.flushMeasurements

Removes a callback registered with addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameters

Returns

Inherited From PerformanceClient.removePerformanceCallback