Trace 設定¶
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| traceSamplingRate | double | いいえ | Trace サンプリングレート。範囲は [0,100] で、小数をサポートします。デフォルトは 100 です。0.1 は 0.1%、1 は 1% を表します。SDK 0.5.8 以降でサポートされています。 |
| sampleRate | double | いいえ | 旧確率設定、互換性のため保持。Trace サンプリングレート。範囲は [0,1]、デフォルトは 1 です。0.1 は 10%、1 は 100% を表します。traceSamplingRate への変更を推奨します。 |
| traceType | enum TraceType | いいえ | トレースタイプ。デフォルトは TraceType.ddTrace で、ddTrace、zipkinMulti、zipkinSingle、traceparent、skywalking、jaeger をサポートします。 |
| enableLinkRUMData | bool | いいえ | RUM データと関連付けるかどうか。デフォルトは false です。 |
| enableAutoTrace | bool | いいえ | http リクエストに Trace Header を自動的に追加するかどうか。デフォルトは false です。HttpOverrides.global を変更して実装されます。プロジェクトでカスタマイズが必要な場合は FTHttpOverrides を継承する必要があります。 |
| enableNativeAutoTrace | bool | いいえ | ネイティブネットワークの自動トレースを有効にするかどうか。iOS NSURLSession、Android OKHttp。デフォルトは false です。 |
パーセントサンプリングへの移行¶
SDK 0.5.8 以降でサポートされています。
サンプリングレートパラメータの命名
SDK 0.5.8 以降では traceSamplingRate の使用を推奨します。値は 0~100 のパーセントで、小数をサポートします。0 はサンプリングなし、100 は全サンプリングを意味します。範囲外、NaN、無限大などの無効な値は ArgumentError をスローします。
旧 sampleRate は引き続き互換性のために保持され、値は 0~1 の確率です。たとえば、旧フィールドの 0.1 は 10%、新フィールドの 0.1 は 0.1% を意味します。新旧フィールドを同時に設定した場合、明示的な 0 を含め、新しいパーセントフィールドが優先されます。
リモートサンプリングフィールドの単位と優先順位については、Flutter リモート設定フィールド を参照してください。
たとえば、12.5% の Trace サンプリングに移行するには、次のようにします:
await FTTracer().setConfig(
enableAutoTrace: true,
- sampleRate: 0.125,
+ traceSamplingRate: 12.5,
);
Tracer ネットワーク分散型トレーシング¶
自動収集¶
FTTracer().setConfig で enableAutoTrace を有効にすることで実装されます。
カスタム Tracer¶
使用方法¶
/// trace HTTP リクエストヘッダーデータを取得します
/// [key] 一意の ID
/// [url] リクエスト URL
Future<Map<String, String>> getTraceHeader(String url, {String? key})
コード例¶
void httpClientGetHttp() async {
var url = 'http://reqeust.url.cn';
var httpClient = HttpClient();
String key = DateTime.now().millisecondsSinceEpoch.toString() + url;
var errorMessage = "";
HttpClientRequest request = await httpClient.getUrl(Uri.parse(url));
HttpClientResponse? response;
try {
final traceHeaders =
await FTTracer().getTraceHeader(request.uri.toString(), key: key);
traceHeaders.forEach((key, value) {
request.headers.add(key, value);
});
response = await request.close();
} catch (exception) {
errorMessage = exception.toString();
} finally {
Map<String, dynamic> requestHeader = {};
Map<String, dynamic> responseHeader = {};
request.headers.forEach((name, values) {
requestHeader[name] = values;
});
if (response != null) {
response.headers.forEach((name, values) {
responseHeader[name] = values;
});
}
}
}
httpライブラリとdioライブラリを使用する場合は、example を参照してください。