技術文章 » Flutter異常監控

Flutter異常監控

2023-01-10 12:01:56

一. 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. 通過FlutterError.onError（21行）和runZonedGuarded（13行）兩個監控點邏輯處理，將異常收攏到Rollbar.error方法中

  1. 將原始異常以Event方式交給Notifier.notify（15行）。

  1. 通過步驟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傳送真實資料到伺服器等。

至此流程圖如下：

異常封包裝流程：

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

如果覺得文章對你有幫助，點贊、收藏、關注、評論，一鍵四連支援，你的支援就是我創作最大的動力。

❤️ 本文原創聽蟬 公眾號：碼裡特別有禪 歡迎關注原創技術文章第一時間推播 ❤️