快速开始¶
本文用于提供 Flutter RUM SDK 的最短接入路径,帮助您以最少步骤完成一次可验证的数据上报。
前置准备¶
开始前,请先完成以下准备:
- 在用户访问监测中分别创建 Android 与 iOS 应用,并获取对应的
appId - 确认上报地址与认证方式:
- 本地环境部署:准备
datakitUrl - 公网 DataWay:准备
datawayUrl和cliToken - 确认项目已完成 SDK 安装
接入步骤¶
- 安装
ft_mobile_agent_flutter - 在应用启动时调用
FTMobileFlutter.sdkConfig - 初始化
FTRUMManager().setConfig(...),并开启 Flutter 异常自动采集 - 在
MaterialApp.navigatorObservers中添加FTRouteObserver() - 如需日志和链路追踪,再初始化
FTLogger与FTTracer - 在控制台确认数据已成功上报
安装 SDK¶
安装方式请直接参考 应用接入。
最小初始化示例¶
void main() async {
runZonedGuarded(() async {
WidgetsFlutterBinding.ensureInitialized();
// 本地环境部署使用 datakitUrl
await FTMobileFlutter.sdkConfig(
datawayUrl: datawayUrl,
cliToken: cliToken,
debug: true,
);
await FTRUMManager().setConfig(
androidAppId: appAndroidId,
iOSAppId: appIOSId,
enableUserResource: true,
);
// Flutter 异常自动采集
FlutterError.onError = FTRUMManager().addFlutterError;
runApp(const MyApp());
}, (Object error, StackTrace stack) {
FTRUMManager().addError(error, stack);
});
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
navigatorObservers: [
// 自动采集页面切换
FTRouteObserver(),
],
home: const HomePage(),
);
}
}
class HomePage extends StatelessWidget {
const HomePage({super.key});
@override
Widget build(BuildContext context) {
return const Placeholder();
}
}
若使用本地环境部署,请将
datawayUrl和cliToken替换为datakitUrl。若需要基于命名路由进行 View 自动采集,请继续在
MaterialApp.routes中配置路由表,详细方式请查看 数据采集自定义规则。
可选:初始化 Log 和 Trace¶
如果您还需要日志采集或链路追踪,可继续追加以下初始化:
await FTLogger().logConfig(
enableCustomLog: true,
enableLinkRumData: true,
);
await FTTracer().setConfig(
enableAutoTrace: true,
enableLinkRUMData: true,
);
验证接入是否成功¶
- 保持
debug: true开启,运行应用 - 打开一个页面、执行一次路由跳转,或发起一次网络请求
- 在 Flutter、Android Studio、Xcode 的控制台中确认出现 SDK 初始化和数据同步相关日志
- 返回观测云控制台,确认应用中已出现对应的 RUM 数据
如果需要进一步排查,请查看 故障排查。
下一步¶
- 完整安装和初始化说明,请继续阅读 应用接入
- 所有初始化参数说明,请阅读 SDK 初始化
- RUM、Log、Trace 的详细配置,请阅读 RUM 配置、Log 配置、Trace 配置
- 如果需要在 Flutter 中接入 H5 页面监测,请继续阅读 WebView 数据监测
- 如果您的项目是原生与 Flutter 混合开发,请继续阅读 原生与 Flutter 混合开发