Class BrowserPerformanceClient

Hierarchy

PerformanceClient
- BrowserPerformanceClient

Implements

IPerformanceClient

Index

Constructors

Methods

addFields addPerformanceCallback addQueueMeasurement calculateQueuedTime discardMeasurements emitEvents endMeasurement generateId getPreQueueTime incrementFields removePerformanceCallback setPreQueueTime startMeasurement startPerformanceMeasurement

Constructors

constructor

new BrowserPerformanceClient(configuration, intFields?, abbreviations?): BrowserPerformanceClient
Parameters
- configuration: Configuration
- Optional intFields: Set<string>
- Optional abbreviations: Map<string, string>
Returns BrowserPerformanceClient
Overrides PerformanceClient.constructor
- Defined in msal-browser/src/telemetry/BrowserPerformanceClient.ts:72

Methods

addFields

addFields(fields, correlationId): void
Saves extra information to be emitted when the measurements are flushed
Parameters
- fields: {
  [key: string]: {} | undefined;
  }
  - [key: string]: {} | undefined
- correlationId: string
Returns void
Implementation of IPerformanceClient.addFields

Inherited from PerformanceClient.addFields
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:182

addPerformanceCallback

addPerformanceCallback(callback): string
Registers a callback function to receive performance events.
Parameters
- callback: PerformanceCallbackFunction
Returns string
Implementation of IPerformanceClient.addPerformanceCallback

Inherited from PerformanceClient.addPerformanceCallback
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:216

addQueueMeasurement

addQueueMeasurement(eventName, correlationId?, queueTime?, manuallyCompleted?): void
Calculates and adds queue time measurement for given performance event.
Parameters
- eventName: string
- Optional correlationId: string
- Optional queueTime: number
- Optional manuallyCompleted: boolean
  
  indicator for manually completed queue measurements
Returns void
Implementation of IPerformanceClient.addQueueMeasurement

Overrides PerformanceClient.addQueueMeasurement
- Defined in msal-browser/src/telemetry/BrowserPerformanceClient.ts:253

calculateQueuedTime

calculateQueuedTime(preQueueTime, currentTime): number
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.
Parameters
- preQueueTime: number
- currentTime: number
Returns number
Implementation of IPerformanceClient.calculateQueuedTime

Inherited from PerformanceClient.calculateQueuedTime
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:147

discardMeasurements

discardMeasurements(correlationId): void
Removes measurements and aux data for a given correlation id.
Parameters
- correlationId: string
Returns void
Implementation of IPerformanceClient.discardMeasurements

Inherited from PerformanceClient.discardMeasurements
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:209

emitEvents

emitEvents(events, correlationId?): void
Emits events to all registered callbacks.
Parameters
- events: PerformanceEvent[]
- Optional correlationId: string
Returns void
Implementation of IPerformanceClient.emitEvents

Inherited from PerformanceClient.emitEvents
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:230

endMeasurement

endMeasurement(event, error?): null | PerformanceEvent
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.
Parameters
- event: PerformanceEvent
- Optional error: unknown
Returns null | PerformanceEvent
Implementation of IPerformanceClient.endMeasurement

Inherited from PerformanceClient.endMeasurement
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:176

generateId

generateId(): string
Generates and returns a unique id, typically a guid.

Returns string

Abstract
Implementation of IPerformanceClient.generateId

Overrides PerformanceClient.generateId
- Defined in msal-browser/src/telemetry/BrowserPerformanceClient.ts:96

getPreQueueTime

getPreQueueTime(eventName, correlationId): number | void
Gets map of pre-queue times by correlation Id
Parameters
- eventName: string
- correlationId: string
Returns number | void
Inherited from PerformanceClient.getPreQueueTime
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:138

incrementFields

incrementFields(fields, correlationId): void
Increment counters to be emitted when the measurements are flushed
Parameters
- fields: {
  [key: string]: number | undefined;
  }
  
  {string[]}
  - [key: string]: number | undefined
- correlationId: string
  
  {string} correlation identifier
Returns void
Implementation of IPerformanceClient.incrementFields

Inherited from PerformanceClient.incrementFields
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:190

removePerformanceCallback

removePerformanceCallback(callbackId): boolean
Removes a callback registered with addPerformanceCallback.
Parameters
- callbackId: string
Returns boolean
Implementation of IPerformanceClient.removePerformanceCallback

Inherited from PerformanceClient.removePerformanceCallback
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:223

setPreQueueTime

setPreQueueTime(eventName, correlationId?): void
Adds pre-queue time to preQueueTimeByCorrelationId map.
Parameters
- eventName: PerformanceEvents
- Optional correlationId: string
Returns void
Implementation of IPerformanceClient.setPreQueueTime

Overrides PerformanceClient.setPreQueueTime
- Defined in msal-browser/src/telemetry/BrowserPerformanceClient.ts:202

startMeasurement

startMeasurement(measureName, correlationId?): InProgressPerformanceEvent
Starts measuring performance for a given operation. Returns a function that should be used to end the measurement. Also captures browser page visibilityState.
Parameters
- measureName: string
- Optional correlationId: string
Returns InProgressPerformanceEvent
Implementation of IPerformanceClient.startMeasurement

Overrides PerformanceClient.startMeasurement
- Defined in msal-browser/src/telemetry/BrowserPerformanceClient.ts:138

startPerformanceMeasurement

startPerformanceMeasurement(measureName, correlationId): IPerformanceMeasurement
Starts and returns an platform-specific implementation of IPerformanceMeasurement. Note: this function can be changed to abstract at the next major version bump.
Parameters
- measureName: string
- correlationId: string
Returns IPerformanceMeasurement

Deprecated
This method will be removed in the next major version
Implementation of IPerformanceClient.startPerformanceMeasurement

Inherited from PerformanceClient.startPerformanceMeasurement
- Defined in msal-common/dist/telemetry/performance/PerformanceClient.d.ts:120

Class BrowserPerformanceClient

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional intFields: Set<string>

Optional abbreviations: Map<string, string>

Returns BrowserPerformanceClient

Methods

addFields

Parameters

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

[key: string]: {} | undefined

correlationId: string

Returns void

addPerformanceCallback

Parameters

callback: PerformanceCallbackFunction

Returns string

addQueueMeasurement

Parameters

eventName: string

Optional correlationId: string

Optional queueTime: number

Optional manuallyCompleted: boolean

Returns void

calculateQueuedTime

Parameters

preQueueTime: number

currentTime: number

Returns number

discardMeasurements

Parameters

correlationId: string

Returns void

emitEvents

Parameters

events: PerformanceEvent[]

Optional correlationId: string

Returns void

endMeasurement

Parameters

event: PerformanceEvent

Optional error: unknown

Returns null | PerformanceEvent

generateId

Returns string

Abstract

getPreQueueTime

Parameters

eventName: string

correlationId: string

Returns number | void

incrementFields

Parameters

fields: { [key: string]: number | undefined; }

[key: string]: number | undefined

correlationId: string

Returns void

removePerformanceCallback

Parameters

callbackId: string

Returns boolean

setPreQueueTime

Parameters

eventName: PerformanceEvents

Optional correlationId: string

Returns void

startMeasurement

Parameters

measureName: string

Optional correlationId: string

Returns InProgressPerformanceEvent

startPerformanceMeasurement

Parameters

`Optional` intFields: Set<string>

`Optional` abbreviations: Map<string, string>

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

`Optional` correlationId: string

`Optional` queueTime: number

`Optional` manuallyCompleted: boolean

`Optional` correlationId: string

`Optional` error: unknown

fields: {
[key: string]: number | undefined;
}

`Optional` correlationId: string

`Optional` correlationId: string