Flutter异常监控 – 肆 | Rollbar源码赏析

敞开成长之旅！这是我参加「日新计划 12 月更文挑战」的第6天，点击检查活动详情

一. Rollbar能够帮你处理哪些问题

无特别阐明，文中Rollbar统指Rollbar-flutter

1. 代码复用

Rollbar官方文档说是纯Dart完成，该特征意味着自带”代码复用”光环。

如图当接入端(Third-APP)调用Rollbar SDK时表明包含的网络(反常数据上传等)和存储(反常存储管理)可到达复用作用。

若Flutter反常监控结构非纯Dart完成(第三篇中Bugsnag)，就存在代码无法复用问题，如图，Dart-Crash-SDK是只是层壳依赖对端SDK，终究导致各渠道(android,ios,…)都须对端SDK(android-crash-sdk, ios-crash-sdk,…)适配，导致网络和存储逻辑对端SDK都须各自完成一遍，严重逻辑重复。

由此在做软件多端架构规划时，Dart侧可了解成是多渠道公共代码集合，假如存在多端逻辑功用代码完全能够抽离到Dart侧以复用，削减测验和人力成本。

2. 定制包装操作

前面两篇文章我们知道，捕获到原始反常后对其间的Error和StackTrace有相当部分的工作是对原始反常数据的包装再将包装类数据发送给对端或许后台，不同结构包装进程是不一样的，如图中Catcher结构包装后类目标是Report，Bugsnag进行了两次包装，第一次是BugsnagError，终究变成BugsnagEvent。

这很好了解，关于同一事物不同结构的需求是不一样的，不同需求注定了不同的包装行为。 原始反常就像一条鱼，口味清淡的Catcher挑选清蒸，重口味的Bugsnag挑选红烧，结构就是不同口味的门客。而Rollbar 能够将包装行为笼统化，将原始的鱼露出给你，让你享用自在烹饪乐趣。

3. 线程切换

反常发生后有许多耗时操作，如原始反常数据包装中存在读取额外字段，反常的存储，查询，加密，上报等。耗时操作都在main isolate 中做, 势必会影响到main isolate的UI 构建等行为，反常数据量比大时UI会有卡顿状况，就像图中状况，

Rollbar支撑将反常耗时处理操作交给子isolate(crash isolate)，让main isolate保持专注做UI构建等以提高运用的流畅度。

4. 追溯生成途径

该需求与第三篇Flutter反常监控 – 叁 |从bugsnag源码学习怎么追溯反常发生途径 相同

该需求意图是能完整记录用户操作的整个行为途径，这样到达明晰指导用户操作进程，对问题的定位很有协助。能够了解成一个小型的埋点体系，只是该埋点体系只是针对反常来做的。

区别在代码层面完成，bugsnag中有主动添加和手动添加途径两种状况，Rollbar中只有手动添加，但是手动添加分类愈加细化，比如图中将Breadcrumb结构进程被分红Breadcrumb.error、Breadcrumb.navigation、Breadcrumb.widget、Breadcrumb.log 对应不同图标事情。

话说，追溯反常生成途径需求是标配么？ 目前看Bugsnag和Rollbar都有完成。

二. 怎么运用

1. 将包添加到您的文件中：pubspec.yaml

dependencies:
  rollbar_flutter: ^0.3.0-beta

1. 运行 flutter pub get

代码中装备:

import 'package:rollbar_flutter/rollbar.dart';
Future<void> main() async {
  const config = Config(
      //accessToken到https://rollbar.com/注册获取
      accessToken: 'YOUR-ROLLBAR-ACCESSTOKEN',
      package: 'rollbar_flutter_example');
  await RollbarFlutter.run(config, () {
    runApp(const MyApp());
  });
}

1. 要求

• Dart SDK >= 2.7.0
• Flutter >= 1.20.0
• A Rollbar account

三. 原了解析

Rollbar是Flutter反常结构，当然少不了读这类源码套路，直接拿出第三篇文章中的通用阅览途径, 依照如下流程一步步走：

1. Flutter反常监控点

1. 接入端经过RollerFlutter.run 进入到Rollbar内部逻辑。 要点重视Config中默许的四个变量：

• Notifier：控制发送事情是经过主线程仍是其他线程中发送。
• Transformer：对反常数据进行转化的转化器。
• Wrangler: 供给对反常数据二次包装机会回来终究发送的实在数据。
• Sender: 将Wrangler供给的实在数据发送。

2. 经过FlutterError.onError（21行）和runZonedGuarded（13行）两个监控点逻辑处理，将反常收拢到Rollbar.error方法中

3. 将原始反常以Event方法交给Notifier.notify（15行）。

4. 经过进程1中Config供给默许完成知道进程3中_notifier是IsolatedNotifier，这样下图中(14行)事情终究会发送到子线程中(45行)。

这里主要涉及到isolate双向通信常识，不清楚能够看下这个帖子Flutte 指北 -> Isolate

• 40~43 ： 实践拿到的是进程1中传入的几个默许值，其间telemetry变量能够了解成数据库封装目标用来缓存反常数据的。
• 46~49 ： 在转化Event之前，需求对数据库中缓存的反常进行处理，其间数据库中缓存数据有两类1. breadcrumb 2. Event 。49会对正常Event进行过期判别，假如过期就删除掉。
• 51~53： 这个经过默许wrangler获取实在数据。
• 54：sender发送实在数据到服务器等。

至此流程图如下：

2. 生成反常包装类

1. 10行:Event转化成Data目标，主要是添加一些除了Error和StackTrack之外信息。比如客户端信息(当时OS体系，OS版别，dart版别，渠道CPU内核数目等)、包名，事情等级，环境等。
2. 11行:Data目标交给Transformer转化器，让开发者能够自界说自己的转化行为。
3. 12行:回来终究实在数据Payload。

反常数据包装流程：

3. 操作包装类

上面进程中经过对Event二次封装，生成终究包装类为Payload, 最后该类转化成字符串发送到Rollbar后台。

四.怎么进行线程切换

上面剖析可知线程切换经过Notifier完成，线程切换思路：经过Config装备自界说Notifier值来指定反常处理运行线程，AsyncNotifier是main UI isolate, IsolateNotifier会新建子线程履行反常相关操作。

Notifier界说

abstract class Notifier {
  // notifier version to be updated with each new release: [todo] automate
  static const version = '0.4.0-beta';
  static const name = 'rollbar-dart';
  Sender get sender;
  Wrangler get wrangler;
  Telemetry get telemetry;
  FutureOr<void> notify(Event event);
  FutureOr<void> dispose();
}

Notifier及子类关系图

子isolate处理长处

默许初始化IsolatedNotifier.spwan 将发生一个新线程。

总结了几点长处：

1. 发送事情之前Telemetry会做数据库相关添加，查询和删除操作，这个耗时。
2. Wrangler目标会经过Transformer对Event进行二次确保操作，这个进程也或许耗时。
3. Sender.send发送事情的时分，假如当时运用某个时间段反常频频，在主线程也或许影响UI。

综上将或许耗时都放到异步线程,能够提高主线程流畅性。

五. 怎么定制包装类

上面剖析可知，包装进程经过Transformer来完成，自界说包装类思路：经过Config装备自界说Transformer值来完成自界说处理反常数据逻辑，能够进行加密等。

Transformer界说

abstract class Transformer {
  FutureOr<Data> transform(Data data, {required Event event});
}

Transformer子类

Config默许完成是这个，假如想自界说数据包装进程，能够复写其间transform，对其间date和event操作。

class NoopTransformer implements Transformer {
  const NoopTransformer(Config _);
  @override
  Data transform(Data data, {required Event event}) => data;
}

六. 规划形式相关

1. 单一职责准则

类功用笼统精准，明晰的职能分工：

1. Isolate切换模块，Notifier 子类完成。
2. 转化模块： Transformer 目标给了自界说和默许的转化方法。
3. 传输模块：Wrangler 将供给终究实在数据并传输给sender。
4. 发送模块：Sender 子类完成，能够扩展出httpSender等。
5. 存储模块：Telemetry 对数据库的包装，可刺进，查询 反常和反常途径目标。

2. 可插拔规划

可插拔意味更自在的功用和更开闭的规划。Rollbar像堆积木一样，将包装，传输，发送，存储经过组合方法一致装备起来更具灵活性。

经过非空命名结构函数供给默许完成，模块直接是以组合装备，外部可设置和替换，满足开闭准则。

const Config({
    this.notifier = IsolatedNotifier.spawn,
    this.wrangler = DataWrangler.new,
    this.transformer = NoopTransformer.new,
    this.sender = PersistentHttpSender.new,
  });

PS: 一直没想明白Dart中结构函数的多非空可选参数与构建者形式有啥不同，感觉前者完全能够替换构建者形式的场景，哪位大佬能告诉我运用场景区别？

七. 其他

考虑到篇幅原因，文章剖析了主要流程，其实还有许多点值得学习和借鉴。如

1. 反常存储和序列化相关逻辑。
2. 多stacktrace处理，例如:Android渠道中的PlatformException。
3. Dart2.15中结构函数拆分。

八. 问题及阐明

1. 官方flutter仍是beta版别官网创建项意图时分没有flutter项目图标挑选，能够不选，直接将客户端accesstoken拿到example中即可。
2. 在发送进程中会报accesstoken的过错，这个是因为之前accesstoken装备过错的状况下记录没发送出去导致的，将运用卸载或许运用数据库删掉后，再用最新的accesstoken测验即可。

九. 长处和缺陷

长处

1. 支撑发送线程切换。
2. 支撑dart层数据库保持数据。
3. 支撑多stacktrace处理，例如:Android渠道中的PlatformException。
4. 整个流程看起来比较顺畅，组件间分工明确，且支撑config可装备。
5. 支撑追溯反常途径。

缺陷

1. 反常追溯途径没有针对导航和网络进行主动埋点的规划都是手动埋点有些费事，这完全能够借鉴Bugsnag来做。
2. 虽然Rollbar官方说是纯Dart完成，但是它存储相关底层用了sqlite3,这玩意是经过通道来完成的，非纯Dart完成存在依赖对端原生功用的危险，是否能够考虑用纯Dart的hive来替换。

十. 参考链接

Flutter反常监控 – 叁 | 从bugsnag源码学习怎么追溯反常发生途径 –

Releases rollbar/rollbar-flutter

Flutter