代表 Trace 的介面。
簽名：
export interface PerformanceTrace
方法
| 方法 | 說明 |
|---|---|
| getAttribute(attr) | 擷取自訂屬性設定的值。 |
| getAttributes() | 傳回追蹤執行個體所有自訂屬性的對應。 |
| getMetric(metricName) | 以該名稱傳回自訂指標的值。如果已有同名的自訂指標，則會傳回零。 |
| incrementMetric(metricName, num) | 加入自訂指標的值。如果提供名稱的自訂指標不存在，就會建立採用該名稱且值與指定數字相同的指標。這個值會降為整數。 |
| putAttribute(attr, value) | 將追蹤記錄的自訂屬性設為特定值。 |
| putMetric(metricName, num) | 將指定自訂指標的值設為指定數字，無論追蹤記錄執行個體中是否已有名稱相同的指標。這個值會降為整數。 |
| record(startTime, 持續時間, 選項) | 從指定參數記錄追蹤記錄。這樣就能直接使用追蹤記錄，不必開始/停止。如果無法在使用追蹤記錄的情況下直接使用追蹤記錄 (例如在載入 Performance SDK 前擷取時間長度)，這就非常實用。 |
| removeAttribute(attr) | 從追蹤記錄執行個體中移除指定的自訂屬性。 |
| start() | 追蹤執行個體的時間開始。 |
| stop() | 停止追蹤執行個體的時間並記錄執行個體的資料。 |
PerformanceTrace.getAttribute()
擷取自訂屬性設定的值。
簽名：
getAttribute(attr: string): string | undefined;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| attr | 字串 | 自訂屬性的名稱。 |
傳回：
字串 |未定義
PerformanceTrace.getAttributes()
傳回追蹤執行個體所有自訂屬性的對應。
簽名：
getAttributes(): {
[key: string]: string;
};
傳回：
{ [key: string]: string;}
PerformanceTrace.getMetric()
以該名稱傳回自訂指標的值。如果已有同名的自訂指標，則會傳回零。
簽名：
getMetric(metricName: string): number;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 指標名稱 | 字串 | 自訂指標的名稱。 |
傳回：
數字
PerformanceTrace.incrementMetric()
加入自訂指標的值。如果提供名稱的自訂指標不存在，就會建立採用該名稱且值與指定數字相同的指標。這個值會降為整數。
簽名：
incrementMetric(metricName: string, num?: number): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 指標名稱 | 字串 | 自訂指標的名稱。 |
| 數字 | 數字 | 要加入自訂指標值的數字。如未提供，則會使用預設值 1。 |
傳回：
void
PerformanceTrace.putAttribute()
將追蹤記錄的自訂屬性設為特定值。
簽名：
putAttribute(attr: string, value: string): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| attr | 字串 | 自訂屬性的名稱。 |
| 值 | 字串 | 自訂屬性的值。 |
傳回：
void
PerformanceTrace.putMetric()
將指定自訂指標的值設為指定數字，無論追蹤記錄執行個體中是否已有名稱相同的指標。這個值會降為整數。
簽名：
putMetric(metricName: string, num: number): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 指標名稱 | 字串 | 自訂指標的名稱。 |
| 數字 | 數字 | 自訂指標的值。 |
傳回：
void
PerformanceTrace.record()
從指定參數記錄追蹤記錄。這樣就能直接使用追蹤記錄，不必開始/停止。如果無法在使用追蹤記錄的情況下直接使用追蹤記錄 (例如在載入 Performance SDK 前擷取時間長度)，這就非常實用。
簽名：
record(startTime: number, duration: number, options?: {
metrics?: {
[key: string]: number;
};
attributes?: {
[key: string]: string;
};
}): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| startTime | 數字 | 自 Epoch 紀元時間起算的追蹤記錄開始時間 (以毫秒為單位)。 |
| 時間長度 | 數字 | 追蹤記錄的時間長度 (以毫秒為單位)。 |
| 選項 | { 指標？：{ [key: string]: number;}；屬性？{ [key: string]: string;}；} | 可選擇保存自訂指標和自訂屬性地圖的物件。 |
傳回：
void
PerformanceTrace.removeAttribute()
從追蹤記錄執行個體中移除指定的自訂屬性。
簽名：
removeAttribute(attr: string): void;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| attr | 字串 | 自訂屬性的名稱。 |
傳回：
void
PerformanceTrace.start()
追蹤執行個體的時間開始。
簽名：
start(): void;
傳回：
void
PerformanceTrace.stop()
停止追蹤執行個體的時間並記錄執行個體的資料。
簽名：
stop(): void;
傳回：
void