トレース設定¶

Tracer の取得¶

通常の uni-app：

import { tracer } from '@/uni_modules/GC-UniPlugin';

uni ミニプログラム：

import { tracer } from '@/uni_modules/GC-JSPlugin';

uni ミニプログラムでは、ホストアプリがトレースの初期化を行い、getTraceHeader() などのランタイム API のみを呼び出します。

トレース初期化設定¶

tracer.setConfig({
    traceType: 'ddTrace',
    enableLinkRUMData: true
});

パラメータ名	タイプ	必須	説明
sampleRate	number	いいえ	サンプリングレート、範囲 `[0,1]`、デフォルト `1`
traceType	string	いいえ	トレースタイプ：`ddTrace`（デフォルト）、`zipkinMultiHeader`、`zipkinSingleHeader`、`traceparent`、`skywalking`、`jaeger`
enableLinkRUMData	boolean	いいえ	RUM データと関連付けるかどうか。デフォルト `false`
enableAutoTrace	boolean	いいえ	ネイティブネットワークの自動トレースを有効にするかどうか。iOS は `NSURLSession`、Android は `OKhttp` をサポート、デフォルト `false`；Android のクラウドビルドは対応していません。uni-app は iOS 側でシステム API を介してネットワークリクエストを送信するため、有効にするとこれらのリクエストは自動でトレースされます。その場合は iOS 側の手動トレース収集を無効にし、トレースと RUM データの関連付けエラーを避けてください。

Tracer ネットワークトレース¶

自動収集¶

gcResourceTracking を有効にすると、標準の uni.request が自動的にトレースヘッダーを取得してマージします。リクエストメソッドを置き換える必要はありません。詳細は Resource 自動収集をご覧ください。

手動収集¶

const requestUrl = 'https://example.com/api';
const key = 'YOUR_REQUEST_ID';
const traceHeader = tracer.getTraceHeader({
    key,
    url: requestUrl
}) || {};

uni.request({
    url: requestUrl,
    header: traceHeader
});

API - getTraceHeader¶

トレースリクエストヘッダーを取得し、HTTP リクエストヘッダーに追加します。

フィールド	タイプ	必須	説明
url	string	はい	リクエスト URL
key	string	いいえ	リクエストの一意識別子。RUM リソースと関連付ける必要がある場合は、同じ key を渡してください。

戻り値の型：object | null。ホストモジュールが利用不可の場合、またはリクエストがトレース設定を満たさない場合に null を返すことがあります。