Trace
を表すインターフェース。
サイン:
export interface PerformanceTrace
メソッド
方法 | 説明 |
---|---|
getAttribute(属性) | カスタム属性に設定されている値を取得します。 |
getAttributes() | トレース インスタンスのすべてのカスタム属性のマップを返します。 |
getMetric(メトリック名) | その名前のカスタム メトリックの値を返します。その名前のカスタム メトリックが存在しない場合は、ゼロが返されます。 |
incrementMetric(metricName, num) | カスタム メトリックの値を追加します。指定された名前のカスタム メトリックが存在しない場合は、その名前と指定された数値に等しい値を持つカスタム メトリックが作成されます。値は整数に切り下げられます。 |
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;
戻り値:
空所