PerformanceTrace interface

表示Trace接口

签名:

export interface PerformanceTrace 

方法

方法描述
获取属性(属性)检索自定义属性设置的值。
获取属性()返回跟踪实例的所有自定义属性的映射。
getMetric(指标名称)返回该名称的自定义指标的值。如果具有该名称的自定义指标不存在,则返回零。
增量度量(度量名称,数字)添加自定义指标的值。如果具有所提供名称的自定义指标不存在,则会创建一个具有该名称且值等于给定数字的指标。该值将向下取整为整数。
putAttribute(属性, 值)将跟踪的自定义属性设置为特定值。
putMetric(度量名称, 数字)将指定自定义指标的值设置为给定数字,无论跟踪实例上是否已存在具有该名称的指标。该值将向下取整为整数。
记录(开始时间、持续时间、选项)记录给定参数的跟踪。这提供了一种直接使用跟踪的方法,无需启动/停止。这对于无法直接使用跟踪的用例非常有用(例如,如果在加载性能 SDK 之前捕获了持续时间)。
删除属性(属性)从跟踪实例中删除指定的自定义属性。
开始()开始跟踪实例的计时。
停止()停止跟踪实例的计时并记录实例的数据。

PerformanceTrace.getAttribute()

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

签名:

getAttribute(attr: string): string | undefined;

参数

范围类型描述
属性细绳自定义属性的名称。

返回:

字符串|不明确的

PerformanceTrace.getAttributes()

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

签名:

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

返回:

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

PerformanceTrace.getMetric()

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

签名:

getMetric(metricName: string): number;

参数

范围类型描述
指标名称细绳自定义指标的名称。

返回:

数字

PerformanceTrace.incrementMetric()

添加自定义指标的值。如果具有所提供名称的自定义指标不存在,则会创建一个具有该名称且值等于给定数字的指标。该值将向下取整为整数。

签名:

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

参数

范围类型描述
指标名称细绳自定义指标的名称。
编号数字要添加到自定义指标值的数字。如果未提供,则使用默认值 1。

返回:

空白

PerformanceTrace.putAttribute()

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

签名:

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

参数

范围类型描述
属性细绳自定义属性的名称。
价值细绳自定义属性的值。

返回:

空白

PerformanceTrace.putMetric()

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

签名:

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

参数

范围类型描述
指标名称细绳自定义指标的名称。
编号数字自定义指标的值。

返回:

空白

PerformanceTrace.record()

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

签名:

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

参数

范围类型描述
开始时间数字自纪元以来的跟踪开始时间(以毫秒为单位)。
期间数字跟踪的持续时间(以毫秒为单位)。
选项{ 指标?:{ [键:字符串]:数字; };属性?:{ [键:字符串]:字符串; }; }一个对象,可以选择保存自定义指标和自定义属性的映射。

返回:

空白

PerformanceTrace.removeAttribute()

从跟踪实例中删除指定的自定义属性。

签名:

removeAttribute(attr: string): void;

参数

范围类型描述
属性细绳自定义属性的名称。

返回:

空白

PerformanceTrace.start()

开始跟踪实例的计时。

签名:

start(): void;

返回:

空白

PerformanceTrace.stop()

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

签名:

stop(): void;

返回:

空白