コンテンツにスキップ

カスタム環境変数

主要フィールド

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 に保存するためのキーを定義します。デフォルトでは未入力で、自動生成されます。
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。任意の文字列。1 単語での指定を推奨します（例：test）。
serviceName string ❌ 所属するビジネスまたはサービスの名前を設定します。Log と RUM の service フィールドデータに影響します。デフォルトは df_rum_android。
autoSync bool ✅ データ収集後に自動的にサーバーへ同期するかどうか。デフォルトは true。
compressIntakeRequests bool ✅ アップロード同期データを deflate 圧縮するかどうか。デフォルトはオフ。
syncPageSize int ✅ 同期リクエストのエントリ数を設定します。範囲は [5,∞)。注意：エントリ数が大きいほど、データ同期に多くの計算リソースを消費します。
syncSleepTime int ✅ 同期の間隔時間を設定します。単位はミリ秒。範囲は [0,5000]。デフォルトでは設定されません。
rumSampleRate float ✅ RUM サンプリングレートを設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。スコープは同一の session_id 下のすべての View、Action、LongTask、Error データです。Android: ft-sdk > 1.6.16
rumSessionOnErrorSampleRate float ✅ エラー収集率を設定します。セッションが 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：同一の OkhttpClient は同一ドメインに対して IP キャッシュメカニズムを持ちます。サーバー側 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"]。
logSampleRate float ✅ Log 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。Android: ft-sdk > 1.6.16
logLevelFilters string json array ✅ ログレベルのフィルタリングを設定します。デフォルトでは設定されません。例：["info","warn"]。
logEnableConsoleLog bool ✅ コンソールログを報告するかどうか。Android のみサポートしています。
logEnableCustomLog bool ✅ カスタムログをアップロードするかどうか。デフォルトは false。
traceSampleRate float ✅ trace 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。Android: ft-sdk > 1.6.16
traceEnableAutoTrace bool ❌ 自動 http trace を有効にするかどうかを設定します。現在は OKhttp の自動トレースのみサポートしています。デフォルトは false。
traceType string ❌ 分散型トレーシングのタイプを設定します。デフォルトは DDTrace。
sessionReplaySampleRate float ❌ セッションリプレイの収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされなかった場合、セッション中にエラーが発生したときに、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 0。

iOS/tvOS

パラメータ名
 データ型 ホットリロード対応 説明
env string ❌ 環境設定。デフォルトは prod。任意の文字列。1 単語での指定を推奨します（例：test）。
serviceName string ❌ 所属するビジネスまたはサービスの名前を設定します。Log と RUM の service フィールドデータに影響します。デフォルトは df_rum_ios。
autoSync bool ✅ データ収集後に自動的にサーバーへ同期するかどうか。デフォルトは true。
compressIntakeRequests bool ✅ アップロード同期データを deflate 圧縮するかどうか。デフォルトはオフ。
syncPageSize int ✅ 同期リクエストのエントリ数を設定します。範囲は [5,∞)。注意：エントリ数が大きいほど、データ同期に多くの計算リソースを消費します。
syncSleepTime int ✅ 同期の間隔時間を設定します。単位はミリ秒。範囲は [0,5000]。デフォルトでは設定されません。
rumSampleRate float ✅ RUM サンプリングレートを設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。スコープは同一の session_id 下のすべての View、Action、LongTask、Error データです。iOS: ft-sdk > 1.5.21
rumSessionOnErrorSampleRate float ✅ エラー収集率を設定します。セッションが rumSampleRate でサンプリングされなかった場合、セッション中にエラーが発生したときに、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 0 です。スコープは rumSampleRate と同じです。ホットリロード対応：iOS: ft-sdk > 1.5.21
rumEnableTraceUserAction bool ❌ ユーザーの Action 操作を追跡するかどうか。デフォルトは false。
rumEnableTraceUserView bool ❌ ユーザーの View 操作を追跡するかどうか。デフォルトは false。
rumEnableTraceUserResource bool ❌ ユーザーのネットワークリクエストを追跡するかどうか。デフォルトは false。
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 アドレスを設定します。デフォルトではフィルタリングしません。例：["10.0.0.1"]。
logSampleRate float ✅ Log 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。iOS: ft-sdk > 1.5.19
logLevelFilters string json array ✅ ログレベルのフィルタリングを設定します。デフォルトでは設定されません。例：["info","warn"]。
logEnableCustomLog bool ✅ カスタムログをアップロードするかどうか。デフォルトは false。
traceSampleRate float ✅ trace 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。iOS: ft-sdk > 1.5.19
traceEnableAutoTrace bool ❌ 自動 http trace を有効にするかどうかを設定します。現在は NSURLSession のみサポートしています。デフォルトは false。
traceType string ❌ 分散型トレーシングのタイプを設定します。デフォルトは DDTrace。
sessionReplaySampleRate float ❌ セッションリプレイの収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされなかった場合、セッション中にエラーが発生したときに、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 0。

React Native

パラメータ名
 データ型 ホットリロード対応 説明
env string ❌ 環境設定。デフォルトは prod。任意の文字列。1 単語での指定を推奨します（例：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]。デフォルトでは設定されません。
rumSampleRate float ✅ RUM サンプリングレートを設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1 です。スコープは同一の session_id 下のすべての View、Action、LongTask、Error データです。
rumSessionOnErrorSampleRate float ✅ エラー収集率を設定します。セッションが rumSampleRate でサンプリングされなかった場合、セッション中にエラーが発生したときに、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 0 です。スコープは rumSampleRate と同じです。
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"]。
logSampleRate float ✅ Log 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1。
logLevelFilters string json array ✅ ログレベルのフィルタリングを設定します。デフォルトでは設定されません。例：["info","warn"]。
logEnableCustomLog bool ✅ カスタムログをアップロードするかどうか。デフォルトは false。
traceSampleRate float ✅ trace 収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1。
traceEnableAutoTrace bool ❌ ネイティブネットワークの自動トレース（iOS NSURLSession、Android OKhttp）を有効にするかどうかを設定します。デフォルトは false。
traceType string ❌ 分散型トレーシングのタイプを設定します。デフォルトは ddTrace、zipkinMultiHeader、zipkinSingleHeader、traceparent、skywalking、jaeger。
sessionReplaySampleRate float ❌ セッションリプレイの収集率を設定します。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 1。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされなかった場合、セッション中にエラーが発生したときに、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]。0 は収集しない、1 は全収集を意味します。デフォルト値は 0。

モバイル端末（Android、iOS/tvOS、React Native）のリモート設定反映ルール：

  • ホットリロード対応：SDK を再初期化することなく、モバイル端末 SDK がリモート設定を同期した後、即座に反映されます。主にレート制限のシナリオに対応します。

  • 設定の削除：次回起動時に反映されます。

  • パラメータ形式の設定エラー：パラメータが対応するデータ型に従って設定されていない場合、または解析エラーが発生した場合、無効な設定とみなされ、一切の効果を持ちません。

フィードバック

このページは役に立ちましたか？