Trace 設定¶
Trace 初期化設定¶
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
| traceSamplingRate | float | いいえ | Trace サンプリングレート。範囲は [0,100] で、小数をサポートします。デフォルトは 100 です。0.1 は 0.1%、1 は 1% を表します。SDK 1.6.8 以降でサポート。 |
| sampleRate | int | いいえ | SDK 1.6.8 以降で非推奨、互換性のため保持。整数パーセントのサンプリングレート。範囲は [0,100] で、デフォルトは 100 です。traceSamplingRate への変更を推奨します。 |
| networkTraceType | FTNetworkTraceType | いいえ | 分散型トレーシングの種類を設定します。デフォルトは DDTrace で、現在は Zipkin、Jaeger、DDTrace、Skywalking(8.0+)、TraceParent(W3C)をサポートします。OpenTelemetry に接続する場合、対応する Trace 種別を選択する際は、サポート対象の種別と agent 関連の設定を確認してください。 |
| enableLinkRumData | BOOL | いいえ | RUM データと関連付けるかどうか。デフォルトは NO |
| enableAutoTrace | BOOL | いいえ | 自動 HTTP trace を有効にするかどうか。デフォルトは NO で、現在は NSURLSession のみをサポートします。 |
| enableAutoTraceURLConnection | BOOL | いいえ | SDK 1.6.8+:NSURLConnection に Trace リクエストヘッダーを自動注入します。デフォルトは NO です。URLSession を制御する enableAutoTrace とは独立しています。詳細は NSURLConnection Trace を参照してください。 |
| traceInterceptor | FTTraceInterceptor | いいえ | URLRequest を通じてカスタム分散型トレーシングを実行するかどうかを判断できます。インターセプトすると判断した場合は TraceContext を返し、インターセプトしない場合は nil を返します。このパラメータは SDK 1.5.10 以降でサポートされます。優先度は URLSession カスタム収集 より低くなります。 |
サンプリングレートパラメータの命名
SDK 1.6.8 以降では traceSamplingRate の使用を推奨します。値は 0~100 のパーセントで、小数をサポートします。無効な値(範囲外、NaN、無限大)は元の設定を上書きしません。旧 sampleRate / samplerate は整数パーセントのみをサポートし、非推奨としてマークされており、将来のバージョンで削除される可能性があります。旧 getter で小数のサンプリングレートを読み取る場合は、整数部分が返されます。
リモートサンプリングフィールドの単位と優先度については、リモート設定フィールド を参照してください。
Trace ネットワーク分散型トレーシング¶
FTTraceConfig の設定で自動モードを有効にできます。また、ユーザーが Trace 関連データをカスタム追加することもできます。カスタム追加用の API は以下のとおりです。
NSString *key = [[NSUUID UUID]UUIDString];
NSURL *url = [NSURL URLWithString:@"http://www.baidu.com"];
// 手動操作: リクエスト前に traceHeader を取得してリクエストヘッダーに追加
NSDictionary *traceHeader = [[FTTraceManager sharedInstance] getTraceHeaderWithKey:key url:url];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
if (traceHeader && traceHeader.allKeys.count>0) {
[traceHeader enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL * __unused stop) {
[request setValue:value forHTTPHeaderField:field];
}];
}
NSURLSession *session=[NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
NSURLSessionTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
// ここにコードを記述
}];
[task resume];
let url:URL = NSURL.init(string: "https://www.baidu.com")! as URL
if let traceHeader = FTExternalDataManager.shared().getTraceHeader(withKey: NSUUID().uuidString, url: url) {
let request = NSMutableURLRequest(url: url)
// 手動操作: リクエスト前に traceHeader を取得してリクエストヘッダーに追加
for (a,b) in traceHeader {
request.setValue(b as? String, forHTTPHeaderField: a as! String)
}
let task = URLSession.shared.dataTask(with: request as URLRequest) { data, response, error in
// ここにコードを記述
}
task.resume()
}
URLSession 高度な収集¶
特定の URLSession インスタンスに対して、より細かい粒度で Resource 収集、Trace 注入、エラーフィルタリングを行う場合は、URLSession カスタム Network 収集 を参照してください。
NSURLConnection Trace¶
SDK 1.6.8+ でサポート
enableAutoTraceURLConnection は NSURLConnection の自動 Trace リクエストヘッダー注入を制御します。デフォルトは NO です。URLSession を制御する enableAutoTrace とは独立しており、RUM の enableTraceURLConnectionResource とも独立しています。
既存の networkTraceType、traceInterceptor、サンプリング設定は引き続き有効です。RUM Resource とその Trace 関連付けを同時に生成するには、別途 NSURLConnection Resource 収集 を有効にし、既存の Trace 関連付けルールに従って enableLinkRumData と Trace 種別を設定する必要があります。