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 文字列 カスタム指標の名前。
num 数値 カスタム指標の値に追加する数値。指定しない場合は、デフォルト値の 1 が使用されます。

戻り値:

void

PerformanceTrace.putAttribute()

トレースのカスタム属性を特定の値に設定する。

署名:

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

パラメータ

パラメータ 型 説明
attr 文字列 カスタム属性の名前。
値 文字列 カスタム属性の値。

戻り値:

void

PerformanceTrace.putMetric()

トレース インスタンスにその名前の指標がすでに存在するかどうかにかかわらず、指定したカスタム指標の値を指定した数値に設定します。この値は最小化されて整数になります。

署名:

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

パラメータ

パラメータ 型 説明
metricName 文字列 カスタム指標の名前。
num 数値 カスタム指標の値。

戻り値:

void

PerformanceTrace.record()

指定されたパラメータからトレースを記録します。これにより、開始/停止を必要とせずにトレースを直接使用できます。これは、トレースを直接使用できないユースケース（Performance SDK が読み込まれる前に継続時間がキャプチャされた場合）に役立ちます。

署名:

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

パラメータ

パラメータ 型 説明
startTime 数値 エポックからのトレース開始時刻（ミリ秒単位）。
duration 数値 トレースの継続時間（ミリ秒単位）。
オプション {指標？:{ [key: string]: number;}属性？:{ [キー: 文字列]: 文字列;}} 必要に応じてカスタム指標とカスタム属性のマップを保持できるオブジェクト。

戻り値:

void

PerformanceTrace.removeAttribute()

指定されたカスタム属性をトレース インスタンスから削除します。

署名:

removeAttribute(attr: string): void;

パラメータ

パラメータ 型 説明
attr 文字列 カスタム属性の名前。

戻り値:

void

PerformanceTrace.start()

トレース インスタンスの時間測定を開始します。

署名:

start(): void;

戻り値:

void

PerformanceTrace.stop()

トレース インスタンスのタイミングを停止し、インスタンスのデータをログに記録します。

署名:

stop(): void;

戻り値:

void