Interface IPerformanceClient

Hierarchy

IPerformanceClient

Implemented by

Index

Methods

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

Methods

addFields

addFields(fields, correlationId): void
Parameters
- fields: {
  [key: string]: {} | undefined;
  }
  - [key: string]: {} | undefined
- correlationId: string
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:33

addPerformanceCallback

addPerformanceCallback(callback): string
Parameters
- callback: PerformanceCallbackFunction
Returns string
- Defined in telemetry/performance/IPerformanceClient.ts:42

addQueueMeasurement

addQueueMeasurement(eventName, correlationId?, queueTime?, manuallyCompleted?): void
Parameters
- eventName: string
- Optional correlationId: string
- Optional queueTime: number
- Optional manuallyCompleted: boolean
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:53

calculateQueuedTime

calculateQueuedTime(preQueueTime, currentTime): number
Parameters
- preQueueTime: number
- currentTime: number
Returns number
- Defined in telemetry/performance/IPerformanceClient.ts:52

discardMeasurements

discardMeasurements(correlationId): void
Parameters
- correlationId: string
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:32

emitEvents

emitEvents(events, correlationId): void
Parameters
- events: PerformanceEvent[]
- correlationId: string
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:43

endMeasurement

endMeasurement(event): null | PerformanceEvent
Parameters
- event: PerformanceEvent
Returns null | PerformanceEvent
- Defined in telemetry/performance/IPerformanceClient.ts:31

generateId

generateId(): string
Returns string
- Defined in telemetry/performance/IPerformanceClient.ts:51

incrementFields

incrementFields(fields, correlationId): void
Parameters
- fields: {
  [key: string]: number | undefined;
  }
  - [key: string]: number | undefined
- correlationId: string
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:37

removePerformanceCallback

removePerformanceCallback(callbackId): boolean
Parameters
- callbackId: string
Returns boolean
- Defined in telemetry/performance/IPerformanceClient.ts:41

setPreQueueTime

setPreQueueTime(eventName, correlationId?): void
Parameters
- eventName: string
- Optional correlationId: string
Returns void
- Defined in telemetry/performance/IPerformanceClient.ts:59

startMeasurement

startMeasurement(measureName, correlationId?): InProgressPerformanceEvent
Parameters
- measureName: string
- Optional correlationId: string
Returns InProgressPerformanceEvent
- Defined in telemetry/performance/IPerformanceClient.ts:27

startPerformanceMeasurement

startPerformanceMeasurement(measureName, correlationId): IPerformanceMeasurement
Parameters
- measureName: string
- correlationId: string
Returns IPerformanceMeasurement

Deprecated
This method will be removed in the next major version
- Defined in telemetry/performance/IPerformanceClient.ts:47

Generated using TypeDoc