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;

返回:

空白