PerformanceTrace interface

表示 Trace 的接口。

签名

export interface PerformanceTrace 

方法

方法 说明
getAttribute(attr) 检索为自定义属性设置的值。
getAttributes() 返回跟踪记录实例的所有自定义属性的映射。
getMetric(metricName) 按该名称返回自定义指标的值。如果不存在同名的自定义指标,则返回零。
incrementMetric(metricName, num) 与自定义指标的值相加。如果不存在使用所提供名称的自定义指标,则系统会使用该名称创建一个自定义指标,并且其值等于指定数字。此值向下舍入为整数。
putAttribute(attr, value) 将跟踪记录的自定义属性设置为特定值。
putMetric(metricName, num) 将指定自定义指标的值设置为给定数字,无论跟踪实例上是否已存在使用该名称的指标。此值向下舍入为整数。
record(startTime, duration, options) 根据给定参数记录跟踪记录。这提供了一种直接使用跟踪记录的方法,而无需启动/停止。这对于无法直接使用跟踪记录的用例非常有用(例如,如果在加载 Performance SDK 之前捕获了时长)。
removeAttribute(attr) 删除属性 从跟踪记录实例中移除指定的自定义属性。
start() 开始跟踪实例的计时。
stop() 错误 停止跟踪实例的计时并记录实例的数据。

PerformanceTrace.getAttribute()

检索为自定义属性设置的值。

签名

getAttribute(attr: string): string | undefined;

参数

参数 类型 说明
attr 字符串 自定义属性的名称。

返回

字符串 |未定义

PerformanceTrace.getAttributes()

返回跟踪记录实例的所有自定义属性的映射。

签名

getAttributes(): {
        [key: string]: string;
    };

返回

{ [键: 字符串]: 字符串;}

PerformanceTrace.getMetric()

按该名称返回自定义指标的值。如果不存在同名的自定义指标,则返回零。

签名

getMetric(metricName: string): number;

参数

参数 类型 说明
metricName 字符串 自定义指标的名称。

返回

数字

PerformanceTrace.incrementMetric()

与自定义指标的值相加。如果不存在使用所提供名称的自定义指标,则系统会使用该名称创建一个自定义指标,并且其值等于指定数字。此值向下舍入为整数。

签名

incrementMetric(metricName: string, num?: number): void;

参数

参数 类型 说明
metricName 字符串 自定义指标的名称。
编号 数字 要添加到自定义指标值中的数字。如果未提供,则使用默认值 1。

返回

void

PerformanceTrace.putAttribute()

将跟踪记录的自定义属性设置为特定值。

签名

putAttribute(attr: string, value: string): void;

参数

参数 类型 说明
attr 字符串 自定义属性的名称。
字符串 自定义属性的值。

返回

void

PerformanceTrace.putMetric()

将指定自定义指标的值设置为给定数字,无论跟踪实例上是否已存在使用该名称的指标。此值向下舍入为整数。

签名

putMetric(metricName: string, num: number): void;

参数

参数 类型 说明
metricName 字符串 自定义指标的名称。
编号 数字 自定义指标的值。

返回

void

PerformanceTrace.record()

根据给定参数记录跟踪记录。这提供了一种直接使用跟踪记录的方法,而无需启动/停止。这对于无法直接使用跟踪记录的用例非常有用(例如,如果在加载 Performance SDK 之前捕获了时长)。

签名

record(startTime: number, duration: number, options?: {
        metrics?: {
            [key: string]: number;
        };
        attributes?: {
            [key: string]: string;
        };
    }): void;

参数

参数 类型 说明
startTime 数字 跟踪记录自纪元以来的开始时间(以毫秒为单位)。
时长 数字 跟踪记录的时长(以毫秒为单位)。
选项 { 指标?:{ [key: string]: number;};属性?:{ [键: 字符串]: 字符串;};} 可以选择包含自定义指标和自定义属性映射的对象。

返回

void

PerformanceTrace.removeAttribute()

从跟踪记录实例中移除指定的自定义属性。

签名

removeAttribute(attr: string): void;

参数

参数 类型 说明
attr 字符串 自定义属性的名称。

返回

void

PerformanceTrace.start()

开始跟踪实例的计时。

签名

start(): void;

返回

void

PerformanceTrace.stop()

停止跟踪实例的计时并记录实例的数据。

签名

stop(): void;

返回

void