- Preparing search index...
- The search index is not available
Documentation
Interface IPerformanceClient
Methods
addFields
- addFields(fields, correlationId): void
-
Parameters
-
fields: {
[key: string]: {} | undefined;
}
-
[key: string]: {} | undefined
-
correlationId: string
Returns void
addPerformanceCallback
- addPerformanceCallback(callback): string
-
Returns string
addQueueMeasurement
- addQueueMeasurement(eventName, correlationId?, queueTime?, manuallyCompleted?): void
-
Parameters
-
eventName: string
-
Optional correlationId: string
-
Optional queueTime: number
-
Optional manuallyCompleted: boolean
Returns void
calculateQueuedTime
- calculateQueuedTime(preQueueTime, currentTime): number
-
Parameters
-
preQueueTime: number
-
currentTime: number
Returns number
discardMeasurements
- discardMeasurements(correlationId): void
-
Returns void
emitEvents
- emitEvents(events, correlationId): void
-
Returns void
endMeasurement
- endMeasurement(event): null | PerformanceEvent
-
generateId
- generateId(): string
-
Returns string
incrementFields
- incrementFields(fields, correlationId): void
-
Parameters
-
fields: {
[key: string]: number | undefined;
}
-
[key: string]: number | undefined
-
correlationId: string
Returns void
removePerformanceCallback
- removePerformanceCallback(callbackId): boolean
-
Returns boolean
setPreQueueTime
- setPreQueueTime(eventName, correlationId?): void
-
Parameters
-
eventName: string
-
Optional correlationId: string
Returns void
startMeasurement
- startMeasurement(measureName, correlationId?): InProgressPerformanceEvent
-
Parameters
-
measureName: string
-
Optional correlationId: string
startPerformanceMeasurement
- startPerformanceMeasurement(measureName, correlationId): IPerformanceMeasurement
-
Parameters
-
measureName: string
-
correlationId: string
Deprecated
This method will be removed in the next major version