BrowserPerformanceClient class
方法
| add |
计算并添加给定性能事件的队列时间度量。 |
| generate |
|
| set |
将预队列时间添加到 preQueueTimeByCorrelationId 映射。 |
| start |
开始测量给定操作的性能。 返回一个函数,该函数应用于结束度量。 还捕获浏览器页面 visibilityState。 |
继承的方法
| add |
保存刷新度量值时要发出的额外信息 |
| add |
注册回调函数以接收性能事件。 |
| calculate |
计算函数排队时的当前时间和时间之间的差异。 注意:如果当前时间和排队时间相同,则队列时间可能为 0。 |
| discard |
删除给定相关 ID 的度量值和辅助数据。 |
| emit |
向所有已注册的回调发出事件。 |
| end |
停止测量操作的性能。 应仅由 PerformanceClient 类直接调用,因为使用者应改用 startMeasurement 返回的函数。 为子度量添加一个名为“[事件名称]DurationMs”的新字段,否则完成并发出事件。 |
| get |
按关联 ID 获取预队列时间的映射 |
| increment |
刷新度量值时要发出的递增计数器 |
| remove |
删除向 addPerformanceCallback 注册的回调。 |
| start |
启动并返回特定于平台的 IPerformanceMeasurement 实现。 注意:此函数可以在下一个主要版本颠簸处更改为抽象。 |
构造函数详细信息
BrowserPerformanceClient(Configuration, Set<string>, Map<string, string>)
new BrowserPerformanceClient(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>)
参数
- configuration
- Configuration
- intFields
-
Set<string>
- abbreviations
-
Map<string, string>
方法详细信息
addQueueMeasurement(string, string, number, boolean)
计算并添加给定性能事件的队列时间度量。
function addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean)
参数
- eventName
-
string
- correlationId
-
string
- queueTime
-
number
- manuallyCompleted
-
boolean
手动完成的队列度量的指示器
generateId()
function generateId(): string
返回
string
setPreQueueTime(PerformanceEvents, string)
将预队列时间添加到 preQueueTimeByCorrelationId 映射。
function setPreQueueTime(eventName: PerformanceEvents, correlationId?: string)
参数
- eventName
- PerformanceEvents
- correlationId
-
string
startMeasurement(string, string)
开始测量给定操作的性能。 返回一个函数,该函数应用于结束度量。 还捕获浏览器页面 visibilityState。
function startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent
参数
- measureName
-
string
- correlationId
-
string
返回
继承的方法详细信息
addFields({[key: string]: {} | undefined}, string)
保存刷新度量值时要发出的额外信息
function addFields(fields: {[key: string]: {} | undefined}, correlationId: string)
参数
- fields
-
{[key: string]: {} | undefined}
- correlationId
-
string
继承自 PerformanceClient.addFields
addPerformanceCallback(PerformanceCallbackFunction)
注册回调函数以接收性能事件。
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
参数
- callback
- PerformanceCallbackFunction
返回
string
继承自 PerformanceClient.addPerformanceCallback
calculateQueuedTime(number, number)
计算函数排队时的当前时间和时间之间的差异。 注意:如果当前时间和排队时间相同,则队列时间可能为 0。
function calculateQueuedTime(preQueueTime: number, currentTime: number): number
参数
- preQueueTime
-
number
- currentTime
-
number
返回
number
继承自 PerformanceClient.calculateQueuedTime
discardMeasurements(string)
删除给定相关 ID 的度量值和辅助数据。
function discardMeasurements(correlationId: string)
参数
- correlationId
-
string
继承自 PerformanceClient.discardMeasurements
emitEvents(PerformanceEvent[], string)
向所有已注册的回调发出事件。
function emitEvents(events: PerformanceEvent[], correlationId?: string)
参数
- events
- correlationId
-
string
继承自 PerformanceClient.emitEvents
endMeasurement(PerformanceEvent, unknown, AccountInfo)
停止测量操作的性能。 应仅由 PerformanceClient 类直接调用,因为使用者应改用 startMeasurement 返回的函数。 为子度量添加一个名为“[事件名称]DurationMs”的新字段,否则完成并发出事件。
function endMeasurement(event: PerformanceEvent, error?: unknown, account?: AccountInfo): null | PerformanceEvent
参数
- event
- PerformanceEvent
- error
-
unknown
- account
- AccountInfo
返回
null | PerformanceEvent
继承自 PerformanceClient.endMeasurement
getPreQueueTime(string, string)
按关联 ID 获取预队列时间的映射
function getPreQueueTime(eventName: string, correlationId: string): number | void
参数
- eventName
-
string
- correlationId
-
string
返回
number | void
继承自 PerformanceClient.getPreQueueTime
incrementFields({[key: string]: number | undefined}, string)
刷新度量值时要发出的递增计数器
function incrementFields(fields: {[key: string]: number | undefined}, correlationId: string)
参数
- fields
-
{[key: string]: number | undefined}
{string[]}
- correlationId
-
string
{string} 相关标识符
继承自 PerformanceClient.incrementFields
removePerformanceCallback(string)
删除向 addPerformanceCallback 注册的回调。
function removePerformanceCallback(callbackId: string): boolean
参数
- callbackId
-
string
返回
boolean
继承自 PerformanceClient.removePerformanceCallback
startPerformanceMeasurement(string, string)
警告
现已弃用此 API。
This method will be removed in the next major version
启动并返回特定于平台的 IPerformanceMeasurement 实现。 注意:此函数可以在下一个主要版本颠簸处更改为抽象。
function startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement
参数
- measureName
-
string
- correlationId
-
string
返回
继承自 PerformanceClient.startPerformanceMeasurement