跳转至

自定义环境变量

关键字段

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 Session Replay 全量采集采样率：用于控制所有会话重放的全量数据采集比例。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]，默认不设置。
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 不发生变化的前提下只会生成一次。
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 ❌ 设置 session replay 采集率，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 1。
sessionReplayOnErrorSampleRate float ❌ 设置错误采集率，当会话未被 sessionReplaySampleRate 采样时，若会话期间发生错误，可以采集到错误前 1 分钟范围的数据，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 0。

iOS/tvOS

参数名称
 数据类型 可热生效 描述
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]，默认不设置。
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 ❌ 设置 session replay 采集率，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 1。
sessionReplayOnErrorSampleRate float ❌ 设置错误采集率，当会话未被 sessionReplaySampleRate 采样时，若会话期间发生错误，可以采集到错误前 1 分钟范围的数据，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 0。

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,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

参数名称
 数据类型 可热生效 描述
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]，默认不设置。
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 ❌ 设置 session replay 采集率，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 1。
sessionReplayOnErrorSampleRate float ❌ 设置错误采集率，当会话未被 sessionReplaySampleRate 采样时，若会话期间发生错误，可以采集到错误前 1 分钟范围的数据，取值范围 [0,1]，0 表示不采集，1 表示全采集，默认值为 0。

移动端（Android、iOS/tvOS、HarmonyOS、React Native）远程配置生效规则：

  • 可热生效：可以在不重新初始化 SDK 的前提下，在移动端 SDK 同步远程配置之后立即生效，主要应对限流的场景；

  • 删除配置：需要下次启动生效；

  • 参数格式配置错误：如果参数不按照对应数据类型进行设置，或解析发生错误，将会视为无效配置，不起任何作用。

文档评价

文档内容是否对您有帮助？