カスタム環境変数¶
主要フィールド¶
Web¶
Web SDK の初期化パラメーターで remoteConfiguration: true を設定してリモート設定を有効にします。Browser SDK 3.3.25 以降では、アプリケーションコード内でリモート応答の処理完了、ローカル設定へのフォールバック、SDK の初期化失敗を区別できます。詳細は Web アプリケーションの接続 を参照してください。
パラメーター名 |
データ型 | 説明 |
|---|---|---|
sessionSampleRate |
number | データ送信のサンプリング率。100 は全量収集、0 は収集しないことを示します。 |
service |
string | Web アプリケーションのサービス名。 |
env |
string | Web アプリケーションの現在の環境。例: prod:本番環境; gray:グレー環境; pre:プレリリース環境; common:共通環境; local:ローカル環境。 |
version |
string | Web アプリケーションのバージョン番号。 |
tracingSampleRate |
number | トレースデータのサンプリング率:100 は全量収集、0 は収集しないことを示します。 |
usePartitionedCrossSiteSessionCookie |
boolean | クロスサイト Cookie を使用するかどうか。サードパーティ Cookie のパーティション分割を有効にします。デフォルトではクロスサイトを許可しません。 |
storeContextsToLocal |
boolean | パブリックデータを localstorage に保存するかどうか。デフォルトでは保存しません。 |
storeContextsKey |
string | localstorage に保存する key を定義します。デフォルトでは未入力で、自動生成されます。 |
sendContentTypeByJson |
boolean | データを application/json で送信する方式。デフォルトは text です。 |
allowFallbackToLocalStorage |
boolean | Cookie が利用できない場合にこのオプションを有効にすると、データを localstorage に保存できます。 |
sessionOnErrorSampleRate |
number | エラーセッションの補正サンプリング率:セッションがサンプリングされていない場合に、セッション中にエラーが発生したとき、この割合で収集します。100 はエラーセッションをすべて収集し、0 はエラーセッションを無視します。 |
sessionReplaySampleRate |
number | セッションリプレイの全量収集サンプリング率:すべてのセッションリプレイの全量データ収集割合を制御します。100 は全量収集、0 は収集しないことを示します。 |
sessionReplayOnErrorSampleRate |
number | エラーセッションリプレイの補正サンプリング率:セッションがサンプリングされていない場合に、セッション中にエラーが発生したとき、この割合で収集します。100 は全量収集、0 は収集しないことを示します。 |
trackUserInteractions |
boolean | ユーザーインタラクションの収集を有効にするかどうか。 |
compressIntakeRequests |
boolean | RUM データのリクエスト内容を圧縮し、大量データ送信時の帯域使用量を削減します。圧縮は Worker スレッドで行われます。 |
traceType |
TraceType | 分散型トレーシングツールのタイプを設定します。デフォルトは ddtrace です。現在、ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent の 6 種類のデータタイプをサポートしています。 |
Android¶
パラメーター名 |
データ型 | 即時反映 | 説明 |
|---|---|---|---|
env |
string |
❌ | 環境設定。デフォルトは prod で、任意の文字列を使用できます。単一の単語(例:test)を推奨します。 |
serviceName |
string |
❌ | 所属するビジネスまたはサービスの名前を設定します。Log と RUM の service フィールドのデータに影響します。デフォルトは df_rum_android です。 |
autoSync |
bool |
✅ | データ収集後にサーバーへ自動同期するかどうか。デフォルトは true です。 |
compressIntakeRequests |
bool |
✅ | アップロード同期データを deflate で圧縮します。デフォルトは無効です。 |
syncPageSize |
int |
✅ | 同期リクエストの件数を設定します。範囲は [5,∞) です。注意:リクエスト件数が大きいほど、データ同期により多くの計算リソースを使用します。 |
syncSleepTime |
int |
✅ | 同期間隔をミリ秒単位で設定します。範囲は [0,5000] で、デフォルトでは設定しません。 |
sessionSamplingRate |
float |
✅ | RUM のサンプリング率(パーセント)を設定します。範囲は [0,100]、デフォルトは 100 です。小数をサポートし、たとえば 0.1 は 0.1% を表します。0 は収集しないこと、100 は全量収集することを示します。ft-sdk >= 1.7.6 でサポート。 |
rumSampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。RUM サンプリングレートを設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。適用範囲は同じ session_id 配下のすべての View、Action、LongTask、Error データです。Android: ft-sdk > 1.6.16 |
sessionOnErrorSamplingRate |
float |
✅ | エラーセッションの補正サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 0 で、小数をサポートします。明示的な新しいフィールドが優先されます。ft-sdk >= 1.7.6 でサポート。 |
rumSessionOnErrorSampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。エラー収集率を設定します。セッションが rumSampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。適用範囲は rumSampleRate と同じです。Android: ft-sdk > 1.6.16 |
rumEnableTraceUserAction |
bool |
❌ | ユーザー操作を自動追跡するかどうか。現在はユーザーの起動とクリック操作のみをサポートします。デフォルトは false です。 |
rumEnableTraceUserView |
bool |
❌ | ユーザーのページ操作を自動追跡するかどうか。デフォルトは false です。 |
rumEnableTraceUserResource |
bool |
❌ | ユーザーのネットワークリクエストを自動追跡するかどうか。OkHttp のみをサポートします。デフォルトは false です。 |
rumEnableResourceHostIP |
bool |
❌ | リクエスト先ドメインの IP を収集するかどうか。適用範囲:EnableTraceUserResource が true の場合のデフォルト収集にのみ影響します。Android:単一の Okhttp では同じドメインに対して IP キャッシュ機構があり、同じ OkhttpClient では接続先サーバーの IP が変わらない限り 1 回だけ生成されます。 |
rumEnableTrackAppUIBlock |
bool |
❌ | UI スタッタリング検出を有効にするかどうか。デフォルトは false です。 |
rumBlockDurationMs |
int |
❌ | UI スタッタリング検出のしきい値を設定します。値の範囲は [100,∞)、単位はミリ秒、デフォルトは 1 秒です。 |
rumEnableTrackAppCrash |
bool |
❌ | App のクラッシュログを送信するかどうか。デフォルトは false です。 |
rumEnableTrackAppANR |
bool |
❌ | ANR 検出を有効にするかどうか。デフォルトは false です。 |
rumEnableTraceWebView |
bool |
❌ | webview データのモニタリングを有効にするかどうか。デフォルトは true です。 |
rumAllowWebViewHost |
string json array |
❌ | データ追跡を許可する webview host アドレスを設定します。デフォルトではフィルタリングしません。例:["10.0.0.1"]。 |
logSamplingRate |
float |
✅ | Log のサンプリング率(パーセント)を設定します。範囲は [0,100]、デフォルトは 100 です。小数をサポートし、たとえば 0.1 は 0.1% を表します。0 は収集しないこと、100 は全量収集することを示します。ft-sdk >= 1.7.6 でサポート。 |
logSampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。Log 収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。Android: ft-sdk > 1.6.16 |
logLevelFilters |
string json array |
✅ | レベルログのフィルタリングを設定します。デフォルトでは設定しません。例:["info","warn"]。 |
logEnableConsoleLog |
bool |
✅ | コンソールログを送信するかどうか。Android のみをサポートします。 |
logEnableCustomLog |
bool |
✅ | カスタムログをアップロードするかどうか。デフォルトは false です。 |
traceSamplingRate |
float |
✅ | Trace のサンプリング率(パーセント)を設定します。範囲は [0,100]、デフォルトは 100 です。小数をサポートし、たとえば 0.1 は 0.1% を表します。0 は収集しないこと、100 は全量収集することを示します。ft-sdk >= 1.7.6 でサポート。 |
traceSampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。trace の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。Android: ft-sdk > 1.6.16 |
traceEnableAutoTrace |
bool |
❌ | 自動 http trace を有効にするかどうか。現在は OKhttp の自動追跡のみをサポートします。デフォルトは false です。 |
traceType |
string |
❌ | 分散型トレーシングのタイプを設定します。デフォルトは DDTrace です。 |
sessionReplaySamplingRate |
float |
✅ | セッションリプレイの通常サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 100 で、小数をサポートします。明示的な新しいフィールドが優先されます。ft-sdk >= 1.7.6 でサポート。 新しい Replay のローカル設定を使用する場合は、ft-session-replay >= 0.1.9 を併用する必要があります。 |
sessionReplaySampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。session replay の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 |
sessionReplayOnErrorSamplingRate |
float |
✅ | セッションリプレイのエラー補正サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 0 で、小数をサポートします。明示的な新しいフィールドが優先されます。ft-sdk >= 1.7.6 でサポート。 新しい Replay のローカル設定を使用する場合は、ft-session-replay >= 0.1.9 を併用する必要があります。 |
sessionReplayOnErrorSampleRate |
float |
✅ | ft-sdk 1.7.6 以降で非推奨。0~1 の単位による互換性を維持。エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。 |
iOS/tvOS¶
有効化と取得方法については iOS 動的設定 を参照してください。WebView とセッションリプレイ関連のフィールドは iOS にのみ適用されます。
パラメーター名 |
データ型 | 即時反映 | 説明 |
|---|---|---|---|
env |
string |
❌ | 環境設定。デフォルトは prod で、任意の文字列を使用できます。単一の単語(例:test)を推奨します。 |
serviceName |
string |
❌ | 所属するビジネスまたはサービスの名前を設定します。Log と RUM の service フィールドのデータに影響します。デフォルトは df_rum_ios です。 |
autoSync |
bool |
✅ | データ収集後にサーバーへ自動同期するかどうか。デフォルトは true です。 |
compressIntakeRequests |
bool |
✅ | アップロード同期データを deflate で圧縮します。デフォルトは無効です。 |
syncPageSize |
int |
✅ | 同期リクエストの件数を設定します。範囲は [5,∞) です。注意:リクエスト件数が大きいほど、データ同期により多くの計算リソースを使用します。 |
syncSleepTime |
int |
✅ | 同期間隔をミリ秒単位で設定します。範囲は [0,5000] で、デフォルトでは設定しません。 |
sessionSamplingRate |
float |
✅ | RUM セッションのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧リモートフィールド rumSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
rumSampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。RUM サンプリングレートを設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。適用範囲は同じ session_id 配下のすべての View、Action、LongTask、Error データです。iOS SDK > 1.5.19 |
sessionOnErrorSamplingRate |
float |
✅ | RUM エラーセッションのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 0 です。旧リモートフィールド rumSessionOnErrorSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
rumSessionOnErrorSampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。エラー収集率を設定します。セッションが rumSampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。適用範囲は rumSampleRate と同じです。iOS SDK > 1.5.19 |
rumEnableTraceUserAction |
bool |
❌ | ユーザーの Action 操作を追跡するかどうか。デフォルトは false です。 |
rumEnableTraceUserView |
bool |
❌ | ユーザーの View 操作を追跡するかどうか。デフォルトは false です。 |
rumEnableTraceUserResource |
bool |
❌ | ユーザーのネットワークリクエストを追跡するかどうか。デフォルトは false です。 |
rumEnableTraceURLConnectionResource |
bool |
✅ | SDK 1.6.8+:NSURLConnection Resource の自動収集を制御します。デフォルトは false で、URLSession を制御する rumEnableTraceUserResource とは独立しています。更新は後続のリクエストに影響します。 |
rumEnableResourceHostIP |
bool |
❌ | リクエスト先ドメインの IP を収集するかどうか。>= iOS 13.0、>= tvOS 13.0 でサポートされます。 |
rumEnableTrackAppUIBlock |
bool |
❌ | UI スタッタリング検出を有効にするかどうか。デフォルトは false です。 |
rumBlockDurationMs |
int |
❌ | UI スタッタリング検出のしきい値を設定します。値の範囲は [100,∞)、単位はミリ秒、デフォルトは 250ms です。 |
rumEnableTrackAppCrash |
bool |
❌ | クラッシュログを収集するかどうか。デフォルトは false です。 |
rumEnableTrackAppANR |
bool |
❌ | ANR 検出を有効にするかどうか。デフォルトは false です。 |
rumEnableTraceWebView |
bool |
❌ | webview データのモニタリングを有効にするかどうか。デフォルトは true です。 |
rumAllowWebViewHost |
string json array |
❌ | WebView host の許可リストを設定します。デフォルトではフィルタリングしません。元の設定は JSON 配列文字列(例:["example.com"])です。コールバックモデルの属性は配列(NSArray / [String])であり、再エンコードは不要です。SDK 1.6.8+ では共有の RUM、Log、Native Visitor ID Bridge に適用されます。[] はすべてを禁止し、リモート設定はローカル設定より優先されます。詳細は 許可リストの説明 を参照してください。 |
logSamplingRate |
float |
✅ | Log のサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧リモートフィールド logSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
logSampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。Log 収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。iOS SDK > 1.5.19 |
logLevelFilters |
string json array |
✅ | レベルログのフィルタリングを設定します。デフォルトでは設定しません。例:["info","warn"]。 |
logEnableCustomLog |
bool |
✅ | カスタムログをアップロードするかどうか。デフォルトは false です。 |
logEnableWebViewLog |
bool |
✅ | SDK 1.6.8+:Native が WebView Browser Logs SDK のログを受信するかを制御します。デフォルトは false です。Native のカスタムログスイッチとは独立しています。ページ側では引き続き Web ログ SDK を接続する必要があります。 |
traceSamplingRate |
float |
✅ | Trace のサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧リモートフィールド traceSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
traceSampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。trace の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。iOS SDK > 1.5.19 |
traceEnableAutoTrace |
bool |
❌ | 自動 http trace を有効にするかどうか。現在は NSURLSession のみをサポートします。デフォルトは false です。 |
traceEnableAutoTraceURLConnection |
bool |
✅ | SDK 1.6.8+:NSURLConnection Trace の自動注入を制御します。デフォルトは false で、URLSession を制御する traceEnableAutoTrace とは独立しています。更新は後続のリクエストに影響します。 |
traceType |
string |
❌ | 分散型トレーシングのタイプを設定します。デフォルトは DDTrace です。 |
sessionReplaySamplingRate |
float |
✅ | セッションリプレイのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧リモートフィールド sessionReplaySampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
sessionReplaySampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。session replay の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 sessionReplaySamplingRate の使用を推奨します。 |
sessionReplayOnErrorSamplingRate |
float |
✅ | セッションリプレイのエラーセッションサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、0.1 は 0.1%、1 は 1% を表します。0 は収集せず、100 は全量収集し、デフォルトは 0 です。旧リモートフィールド sessionReplayOnErrorSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。無効な値は既存の設定を上書きしません。SDK 1.6.8 以降でサポート。 |
sessionReplayOnErrorSampleRate |
float |
✅ | SDK 1.6.8 以降で非推奨。[0,1] の単位による互換性を維持。エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。 sessionReplayOnErrorSamplingRate の使用を推奨します。 |
HarmonyOS¶
パラメーター名 |
データ型 | 即時反映 | 説明 |
|---|---|---|---|
env |
string |
❌ | 環境設定。デフォルトは prod です。新しい値は次回の SDK 初期化時にキャッシュからマージされます。 |
serviceName |
string |
❌ | Log、RUM、Trace の service フィールドを設定します。デフォルトは df_rum_harmonyos です。新しい値は次回の SDK 初期化時に有効になります。 |
autoSync |
bool |
✅ | データ収集後にサーバーへ自動同期するかどうか。デフォルトは true です。無効にした後は FTSDK.flushSyncData() で能動的にアップロードできます。 |
compressIntakeRequests |
bool |
✅ | 後続のアップロードリクエストに zlib でラップした deflate 圧縮を使用するかどうか。デフォルトは true です。圧縮が利用できない場合は平文アップロードにフォールバックします。 |
syncPageSize |
int |
✅ | 後続の 1 回の同期あたりの件数を設定します。小数は切り捨てられ、動的更新時は [1,500] に制限されます。 |
syncSleepTime |
int |
✅ | 連続する同期リクエストの間隔をミリ秒単位で設定します。範囲は [0,5000]、デフォルトは 0 です。 |
rumSampleRate |
float |
✅ | RUM サンプリングレートを設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルトは 1 です。同じ session_id の View、Action、LongTask、Error データに適用されます。 |
rumSessionOnErrorSampleRate |
float |
✅ | エラーセッションの補正サンプリング率を設定します。値の範囲は [0,1]、デフォルトは 0 です。セッションが rumSampleRate で収集されずにエラーが発生した場合、この割合でエラー発生直前 1 分間の範囲のデータを補正収集します。 |
rumEnableTraceUserAction |
bool |
❌ | 自動 Action 収集を有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableTraceUserView |
bool |
❌ | 自動 View 収集を有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableTraceUserResource |
bool |
❌ | 自動 Resource 収集を有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableResourceHostIP |
bool |
❌ | リクエスト先ドメインの IP を収集するかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableTrackAppUIBlock |
bool |
❌ | UI スタッタリング検出を有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumBlockDurationMs |
int |
❌ | UI スタッタリングのしきい値。単位はミリ秒で、最小値は 100、デフォルトは 1000 です。rumEnableTrackAppUIBlock とともに設定した場合にのみ、次回の初期化時に適用されます。 |
rumEnableTrackAppCrash |
bool |
❌ | App クラッシュのモニタリングを有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableTrackAppANR |
bool |
❌ | ANR のモニタリングを有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumEnableTraceWebView |
bool |
❌ | WebView データのモニタリングを有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
rumAllowWebViewHost |
string json array |
❌ | 収集を許可する WebView Host を設定します。デフォルトではフィルタリングしません。例:["10.0.0.1"]。新しい値は次回の SDK 初期化時に有効になります。 |
logSampleRate |
float |
✅ | Log サンプリングレートを設定します。値の範囲は [0,1]、デフォルトは 1 です。 |
logLevelFilters |
string json array |
✅ | ログレベルのフィルタリングを設定します。デフォルトでは設定しません。例:["info","warn"]。 |
logEnableCustomLog |
bool |
✅ | カスタムログをアップロードするかどうか。デフォルトは false です。 |
logEnableConsoleLog |
bool |
✅ | console.*、hilog.* の自動ログ収集を有効にするかどうか。対応する HarmonyOS コンパイルプラグインを接続し、有効にする必要があります。ft_sdk 0.1.17 以降でサポートされます。 |
traceSampleRate |
float |
✅ | Trace サンプリングレートを設定します。値の範囲は [0,1]、デフォルトは 1 です。 |
traceEnableAutoTrace |
bool |
❌ | 自動 HTTP Trace を有効にするかどうか。デフォルトは false です。新しい値は次回の SDK 初期化時に有効になります。 |
traceType |
string |
❌ | Trace タイプを設定します。デフォルトは ddtrace です。ddtrace、zipkin_multi_header、zipkin_single_header、traceparent、skywalking、jaeger をサポートします。新しい値は次回の SDK 初期化時に有効になります。 |
sessionReplaySampleRate |
float |
❌ | session replay の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 |
sessionReplayOnErrorSampleRate |
float |
❌ | エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。 |
React Native¶
SDK 0.4.3 以降では小数パーセントのサンプリングフィールドをサポートします。旧確率サンプリングフィールドは非推奨ですが、互換性のために維持されています。
有効化と取得方法については React Native 動的設定 を参照してください。
パラメーター名 |
データ型 | 即時反映 | 説明 |
|---|---|---|---|
env |
string |
❌ | 環境設定。デフォルトは prod で、任意の文字列を使用できます。単一の単語(例:test)を推奨します。 |
serviceName |
string |
❌ | 所属するビジネスまたはサービスの名前を設定します。Log と RUM の service フィールドのデータに影響します。デフォルト:df_rum_ios、df_rum_android。 |
autoSync |
bool |
✅ | データ収集後にサーバーへ自動同期するかどうか。デフォルトは true です。 |
compressIntakeRequests |
bool |
✅ | アップロード同期データを deflate で圧縮します。デフォルトは無効です。 |
syncPageSize |
int |
✅ | 同期リクエストの件数を設定します。範囲は [5,∞) です。注意:リクエスト件数が大きいほど、データ同期により多くの計算リソースを使用します。 |
syncSleepTime |
int |
✅ | 同期間隔をミリ秒単位で設定します。範囲は [0,5000] で、デフォルトでは設定しません。 |
sessionSamplingRate |
float |
✅ | RUM セッションのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 100 です。同じ Session 配下の RUM データに適用されます。旧フィールド rumSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
rumSampleRate |
float |
✅ | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。RUM サンプリングレートを設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。適用範囲は同じ session_id 配下のすべての View、Action、LongTask、Error データです。 sessionSamplingRate の使用を推奨します。 |
sessionOnErrorSamplingRate |
float |
✅ | RUM エラーセッションのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 0 です。通常のセッションサンプリングで選択されなかったセッションに使用します。エラー発生時には、エラー発生前 1 分間の範囲のデータを収集できます。旧フィールド rumSessionOnErrorSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
rumSessionOnErrorSampleRate |
float |
✅ | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。エラー収集率を設定します。セッションが rumSampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。適用範囲は rumSampleRate と同じです。 sessionOnErrorSamplingRate の使用を推奨します。 |
rumEnableTraceUserAction |
bool |
❌ | Native Action の追跡を行うかどうか。デフォルトは false です。 |
rumEnableTraceUserView |
bool |
❌ | Native View の自動追跡を行うかどうか。デフォルトは false です。 |
rumEnableTraceUserResource |
bool |
❌ | Native Resource の自動追跡を有効にするかどうか。デフォルトは false です。 |
rumEnableResourceHostIP |
bool |
❌ | リクエスト先ドメインの IP を収集するかどうか。適用範囲:enableNativeUserResource が true の場合のデフォルト収集にのみ影響します。iOS:>= iOS 13 でサポートされます。Android:同じ OkhttpClient では IP キャッシュ機構が存在します。 |
rumEnableTrackAppUIBlock |
bool |
❌ | Native Freeze を収集するかどうか。デフォルトは false です。 |
rumBlockDurationMs |
int |
❌ | Native Freeze のスタッタリングしきい値を設定します。値の範囲は [100,∞)、単位はミリ秒です。iOS のデフォルトは 250ms、Android のデフォルトは 1000ms です。 |
rumEnableTrackAppCrash |
bool |
❌ | Android Java Crash と OC/C/C++ のクラッシュモニタリングを有効にするかどうか。デフォルトは false です。 |
rumEnableTrackAppANR |
bool |
❌ | Native ANR のモニタリングを有効にするかどうか。デフォルトは false です。 |
rumEnableTraceWebView |
bool |
❌ | webview データのモニタリングを有効にするかどうか。デフォルトは true です。 |
rumAllowWebViewHost |
string json array |
❌ | データ追跡を許可する webview host アドレスを設定します。デフォルトではフィルタリングしません。例:["10.0.0.1"]。SDK 0.4.3 以降では WebView RUM とログの両方に適用され、ローカルの FTMobileConfig.allowWebViewHost および旧 RUM 設定より優先されます。 |
logSamplingRate |
float |
✅ | Log のサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧フィールド logSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
logSampleRate |
float |
✅ | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。Log 収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 logSamplingRate の使用を推奨します。 |
logLevelFilters |
string json array |
✅ | レベルログのフィルタリングを設定します。デフォルトでは設定しません。例:["info","warn"]。 |
logEnableCustomLog |
bool |
✅ | カスタムログをアップロードするかどうか。デフォルトは false です。 |
logEnableWebViewLog |
bool |
✅ | WebView 内の Browser Logs SDK が生成するログを受信するかどうか。デフォルトは false で、ローカルの FTLogConfig.enableWebViewLog を上書きします。カスタムログスイッチとは独立しており、ページ側では引き続き Browser Logs SDK を接続する必要があります。SDK 0.4.3 以降でサポート。 |
traceSamplingRate |
float |
✅ | Trace のサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 100 です。旧フィールド traceSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
traceSampleRate |
float |
✅ | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。trace の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 traceSamplingRate の使用を推奨します。 |
traceEnableAutoTrace |
bool |
❌ | ネイティブネットワークの自動追跡を有効にするかどうか。iOS は NSURLSession、Android は OKhttp です。デフォルトは false です。 |
traceType |
string |
❌ | 分散型トレーシングのタイプを設定します。デフォルトは ddTrace、zipkinMultiHeader、zipkinSingleHeader、traceparent、skywalking、jaeger です。 |
sessionReplaySamplingRate |
float |
✅ | セッションリプレイのサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 100 です。RUM セッションのサンプリングに基づいて Replay サンプリングを行います。旧フィールド sessionReplaySampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
sessionReplaySampleRate |
float |
✅(SDK 0.4.3 以降でサポート) | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。session replay の収集率を設定します。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 1 です。 sessionReplaySamplingRate の使用を推奨します。 |
sessionReplayOnErrorSamplingRate |
float |
✅ | セッションリプレイのエラーセッションサンプリング率(パーセント)。範囲は [0,100]、小数をサポートし、1 は 1%、0 は収集せず、100 は全量収集し、デフォルトは 0 です。通常の Replay サンプリングで選択されなかったセッションに使用します。エラー発生時には、エラー発生前 1 分間の範囲のデータを収集できます。旧フィールド sessionReplayOnErrorSampleRate と同時に有効な場合は、0 を含めてこのフィールドを優先します。SDK 0.4.3 以降でサポート。 |
sessionReplayOnErrorSampleRate |
float |
✅(SDK 0.4.3 以降でサポート) | SDK 0.4.3 以降で非推奨。[0,1] の単位による互換性を維持。エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合に、セッション中にエラーが発生すると、エラー発生直前 1 分間の範囲のデータを収集できます。値の範囲は [0,1] で、0 は収集しないこと、1 は全量収集することを示し、デフォルト値は 0 です。 sessionReplayOnErrorSamplingRate の使用を推奨します。 |
Flutter¶
Flutter SDK 0.5.7 以降ではリモート設定をサポートします。SDK 0.5.8 以降では以下のパーセントサンプリングフィールドおよび
logEnableWebViewLogをサポートします。Flutter のセッションリプレイサンプリングフィールドを使用するには、ft_session_replay_flutter0.1.1 以降の互換バージョンをインストールして初期化する必要があります。
有効化と更新方法については Flutter 動的設定 を参照してください。下表はサーバー側のリモート設定フィールドで、フィールド名はネイティブ SDK に準拠しています。未設定のフィールドは既存の設定を引き継ぎます。表中のデフォルト値は、ローカル設定もリモート設定も行っていない場合の SDK デフォルト値を指します。
サンプリング、ログフィルタリング、データアップロードなどの共通設定は Flutter データに影響します。ネイティブの View、Action、Resource、スタッタリングなどの収集スイッチは対応するネイティブ収集のみを制御し、Dart 側の設定は変更しません。rumEnableTraceUserView は Flutter の自動ルーティングを制御せず、rumEnableTraceUserResource は enableUserResource を変更せず、traceEnableAutoTrace は Dart のネットワーク追跡の enableAutoTrace を変更しません。Flutter LongTask の enableLongTask と dartLongTaskThreshold は現時点ではリモート設定をサポートしていません。
パラメーター名 |
データ型 | 即時反映 | 説明 |
|---|---|---|---|
env |
string |
❌ | 環境。デフォルトは prod で、単一の単語(例:test)を推奨します。 |
serviceName |
string |
❌ | ビジネスまたはサービスの名前。Log と RUM の service フィールドに影響します。iOS のデフォルトは df_rum_ios、Android のデフォルトは df_rum_android です。 |
autoSync |
bool |
✅ | 収集データを自動アップロードするかどうか。デフォルトは true です。 |
compressIntakeRequests |
bool |
✅ | アップロードデータを deflate で圧縮するかどうか。Flutter SDK 0.5.7 以降のデフォルトは true、それ以前のデフォルトは false です。 |
syncPageSize |
int |
✅ | バッチごとのアップロード件数。値は 5 以上で、デフォルトは 10 です。件数が大きいほど、同期に必要な計算リソースが増えます。 |
syncSleepTime |
int |
✅ | バッチ間の同期間隔をミリ秒単位で設定します。範囲は [0,5000]、デフォルトは 0 です。 |
sessionSamplingRate |
float |
✅ | RUM セッションのサンプリング率(パーセント)。範囲は [0,100]、デフォルトは 100 で、同じセッション内の Flutter とネイティブ RUM データに影響します。SDK 0.5.8 以降でサポートされます。 |
rumSampleRate |
float |
✅ | 旧 RUM セッションサンプリング確率との互換用。範囲は [0,1]、デフォルトは 1 です。sessionSamplingRate の使用を推奨します。 |
sessionOnErrorSamplingRate |
float |
✅ | 通常の RUM セッションサンプリングに該当しなかった場合のエラー補正サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 0 です。SDK 0.5.8 以降でサポートされます。 |
rumSessionOnErrorSampleRate |
float |
✅ | 旧 RUM エラー補正サンプリング確率との互換用。範囲は [0,1]、デフォルトは 0 です。sessionOnErrorSamplingRate の使用を推奨します。 |
rumEnableTraceUserAction |
bool |
❌ | ネイティブ Action を自動収集するかどうか。デフォルトは false です。Flutter から手動で送信される Action は制御しません。 |
rumEnableTraceUserView |
bool |
❌ | ネイティブ View を自動収集するかどうか。デフォルトは false です。Flutter のルーティング View は制御しません。 |
rumEnableTraceUserResource |
bool |
❌ | ネイティブネットワーク Resource を自動収集するかどうか。デフォルトは false です。Dart の HttpClient または WebSocket の収集は制御しません。 |
rumEnableResourceHostIP |
bool |
❌ | ネイティブ Resource リクエストの Host IP を収集するかどうか。デフォルトは false です。ネイティブネットワークの自動収集にのみ影響します。 |
rumEnableTrackAppUIBlock |
bool |
❌ | ネイティブメインスレッドのスタッタリングを収集するかどうか。デフォルトは false です。Flutter Dart のメイン Isolate の LongTask 検出は制御しません。 |
rumBlockDurationMs |
int |
❌ | ネイティブメインスレッドのスタッタリングしきい値。単位はミリ秒で、値は 100 以上です。iOS のデフォルトは 250、Android のデフォルトは 1000 です。 |
rumEnableTrackAppCrash |
bool |
❌ | ネイティブクラッシュのモニタリングを有効にするかどうか。デフォルトは false です。 |
rumEnableTrackAppANR |
bool |
❌ | ネイティブ ANR のモニタリングを有効にするかどうか。デフォルトは false です。 |
rumEnableTraceWebView |
bool |
❌ | WebView RUM データを収集するかどうか。デフォルトは true です。 |
rumAllowWebViewHost |
string json array |
❌ | データ収集を許可する WebView Host のリスト。デフォルトではフィルタリングしません。例:["example.com"]。[] はすべて禁止を表します。SDK 0.5.8 以降では WebView RUM とログの両方に適用され、FTMobileFlutter.sdkConfig(allowWebViewHost: ...) および旧 RUM 設定より優先されます。 |
logSamplingRate |
float |
✅ | Log のサンプリング率(パーセント)。範囲は [0,100]、デフォルトは 100 です。SDK 0.5.8 以降でサポートされます。 |
logSampleRate |
float |
✅ | 旧 Log サンプリング確率との互換用。範囲は [0,1]、デフォルトは 1 です。logSamplingRate の使用を推奨します。 |
logLevelFilters |
string json array |
✅ | ログレベルのフィルタリング。デフォルトではフィルタリングしません。例:["info","error"]。 |
logEnableCustomLog |
bool |
✅ | FTLogger などのインターフェース経由で送信されるカスタムログをアップロードするかどうか。デフォルトは false です。 |
logEnableConsoleLog |
bool |
✅ | Android のみをサポートし、ネイティブコンソールログの収集を制御します。Dart の print() を自動収集するものではありません。 |
logEnableWebViewLog |
bool |
✅ | WebView 内の Browser Logs SDK が生成するログを受信するかどうか。デフォルトは false で、カスタムログスイッチとは独立しています。ページ側では引き続き Browser Logs SDK を接続する必要があります。詳細は WebView ログ収集 を参照してください。SDK 0.5.8 以降でサポートされます。 |
traceSamplingRate |
float |
✅ | Trace のサンプリング率(パーセント)。範囲は [0,100]、デフォルトは 100 です。SDK 0.5.8 以降でサポートされます。 |
traceSampleRate |
float |
✅ | 旧 Trace サンプリング確率との互換用。範囲は [0,1]、デフォルトは 1 です。traceSamplingRate の使用を推奨します。 |
traceEnableAutoTrace |
bool |
❌ | ネイティブネットワークの自動追跡を有効にするかどうか。iOS は NSURLSession、Android は OkHttp です。デフォルトは false です。Dart のネットワーク追跡の enableAutoTrace は制御しません。 |
traceType |
string |
❌ | 分散型トレーシングのタイプ。例:ddTrace、traceparent、jaeger。デフォルトは ddTrace です。 |
sessionReplaySamplingRate |
float |
✅ | RUM セッションサンプリングに基づく Replay サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 100 です。Core SDK 0.5.8、Replay SDK 0.1.1 以降でサポートされます。 |
sessionReplaySampleRate |
float |
✅ | サーバー側互換の旧 Replay サンプリング確率。範囲は [0,1]、デフォルトは 1 です。sessionReplaySamplingRate の使用を推奨します。 |
sessionReplayOnErrorSamplingRate |
float |
✅ | 通常の Replay サンプリングに該当しなかった場合のエラー補正サンプリング率(パーセント)。範囲は [0,100]、デフォルトは 0 です。Core SDK 0.5.8、Replay SDK 0.1.1 以降でサポートされます。 |
sessionReplayOnErrorSampleRate |
float |
✅ | サーバー側互換の旧 Replay エラー補正サンプリング確率。範囲は [0,1]、デフォルトは 0 です。sessionReplayOnErrorSamplingRate の使用を推奨します。 |
パーセントフィールドはすべて小数をサポートします。0.1 は 0.1%、1 は 1% を表し、0 はサンプリングしないこと、100 は全量サンプリングすることを示します。同じ項目で有効な新旧フィールドが同時に設定された場合、明示的な 0 を含めて新しいパーセントフィールドが優先されます。旧確率値から移行する際は換算が必要です。たとえば 0.125 は 12.5 に対応し、いずれも 12.5% を表します。
モバイル(Android、iOS/tvOS、HarmonyOS、React Native、Flutter)におけるリモート設定の反映ルール:
-
即時反映:SDK を再初期化することなく、モバイル SDK がリモート設定を同期した直後に有効になります。主にレート制限が発生するシナリオに対応します。
-
設定の削除:次回起動時に有効になります。
-
パラメーター形式の設定エラー:パラメーターが対応するデータ型に従って設定されていない場合、または解析エラーが発生した場合、無効な設定とみなされ、何の効果もありません。