コンテンツにスキップ

カスタム環境変数

主要フィールド

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。任意の文字列。単一の単語を推奨します（例：test）。
serviceName string ❌ 所属するビジネスまたはサービスの名前を設定します。ログと 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：単一の Okhttp は同じドメインに対する IP キャッシュメカニズムが存在するため、同じ OkhttpClient は接続先サーバーの IP が変わらない限り 1 回だけ生成されます。
rumEnableTrackAppUIBlock bool ❌ UI のカクつき検出を有効にするかどうか。デフォルトは false です。
rumBlockDurationMs int ❌ UI のカクつき検出のしきい値を設定します。範囲は [100,∞)、単位はミリ秒、デフォルトは 1 秒です。
rumEnableTrackAppCrash bool ❌ アプリのクラッシュログを報告するかどうか。デフォルトは false です。
rumEnableTrackAppANR bool ❌ ANR 検出を有効にするかどうか。デフォルトは false です。
rumEnableTraceWebView bool ❌ webview データモニタリングを有効にするかどうか。デフォルトは true です。
rumAllowWebViewHost string json array ❌ データ追跡を許可する webview host アドレスを設定します。デフォルトではフィルタリングしません。例：["10.0.0.1"]。
logSampleRate float ✅ ログ収集率を設定します。範囲は [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 ❌ session replay の収集率を設定します。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 1 です。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合、セッション中にエラーが発生すると、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 0 です。

iOS/tvOS

パラメータ名
 データ型 即時反映 説明
env string ❌ 環境設定。デフォルトは prod。任意の文字列。単一の単語を推奨します（例：test）。
serviceName string ❌ 所属するビジネスまたはサービスの名前を設定します。ログと 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 ✅ ログ収集率を設定します。範囲は [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 ❌ session replay の収集率を設定します。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 1 です。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合、セッション中にエラーが発生すると、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 0 です。

HarmonyOS

パラメータ名
 データ型 即時反映 説明
env string ❌ 環境設定。デフォルトは prod。新しい値は次回の SDK 初期化時にキャッシュからマージされます。
serviceName string ❌ ログ、RUM、トレースの service フィールドを設定します。デフォルトは df_rum_harmonyos。新しい値は次回の SDK 初期化時に有効になります。
autoSync bool ✅ データ収集後にサーバーへ自動同期するかどうか。デフォルトは true。オフにした場合は FTSDK.flushSyncData() で手動アップロードできます。
compressIntakeRequests bool ✅ 後続のアップロードリクエストに zlib でラップされた deflate 圧縮を使用するかどうか。デフォルトは true。圧縮が使用できない場合は平文アップロードにフォールバックします。
syncPageSize int ✅ 後続の単回同期の項目数を設定します。小数は切り捨てられ、動的更新時には [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 ❌ アプリのクラッシュモニタリングを有効にするかどうか。デフォルトは 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 ✅ ログのサンプリング率を設定します。範囲は [0,1]、デフォルトは 1 です。
logLevelFilters string json array ✅ ログレベルフィルタを設定します。デフォルトでは未設定です。例：["info","warn"]。
logEnableCustomLog bool ✅ カスタムログをアップロードするかどうか。デフォルトは false です。
logEnableConsoleLog bool ✅ console.*、hilog.* の自動ログ収集を有効にするかどうか。対応する HarmonyOS コンパイルプラグインを併せて導入し、有効にする必要があります。ft_sdk 0.1.17 以降のバージョンでサポートされています。
traceSampleRate float ✅ トレースのサンプリング率を設定します。範囲は [0,1]、デフォルトは 1 です。
traceEnableAutoTrace bool ❌ 自動 HTTP トレースを有効にするかどうか。デフォルトは false。新しい値は次回の SDK 初期化時に有効になります。
traceType string ❌ トレースタイプを設定します。デフォルトは 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

パラメータ名
 データ型 即時反映 説明
env string ❌ 環境設定。デフォルトは prod。任意の文字列。単一の単語を推奨します（例：test）。
serviceName string ❌ 所属するビジネスまたはサービスの名前を設定します。ログと 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 ✅ ログ収集率を設定します。範囲は [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 ❌ session replay の収集率を設定します。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 1 です。
sessionReplayOnErrorSampleRate float ❌ エラー収集率を設定します。セッションが sessionReplaySampleRate でサンプリングされていない場合、セッション中にエラーが発生すると、エラー発生前 1 分間のデータを収集できます。範囲は [0,1]、0 は収集しない、1 は全収集を意味し、デフォルト値は 0 です。

モバイル端末（Android、iOS/tvOS、HarmonyOS、React Native）のリモート設定有効化ルール：

  • 即時反映：SDK を再初期化せずに、モバイル SDK がリモート設定を同期した後にすぐに有効になります。主にレートリミットのシナリオに対応します。

  • 設定の削除：次回起動時に有効になります。

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

フィードバック

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