Flutter エージェント

前提条件

Flutter のインストールに必要な前提条件は以下の通りです。

  • Flutter SDK >=2.12.0 <3.0.0

アンドロイド

  • Android 5.0以上 - SDK 21以上
  • Android Gradleプラグイン - 4.2.0+
  • Gradleバージョン - 6.7.1+

iOS

  • Mac OS 10.15.7以上
  • iOS 12以上
  • X-Code 12.2以上のダウンロードとインストール
  • cocoa podsをシステムにインストール

SixthSense Flutter の依存関係の追加

以下の手順で iOS と Android の両方に Flutter の依存関係を追加します。

  1. アプリケーションの pubspec.yaml ファイルの dependencies の後ろに以下を追加し、pub get コマンドを実行します。
sixthsense:
url: https://Flutter-Monitoring:<git-lab-access-token>@artifacts-observability.sixthsense.rakuten.com/sixthsense/sixthsense-mobile-monitoring-flutter.git
ref: develop
path: sixthsense

GitLab のアクセストークンは、オンボーディング時に楽天のカスタマーサポートチームより提供されます。

  1. main.dart ファイルを以下のように変更します。
import 'package:sixthsense/sixthsense.dart';
void main() {
runZonedGuarded<Future<void>>() async {
WidgetsFlutterBinding.ensureInitialized();
await sixthsense.initialize();
runApp(const YourApp());
}, (error, stack) {
sixthsense.reportError(error, stack);
exit(1);
}};
  1. 処理されたエラーを報告するには、xixthsense をインポートした後、.dart ファイルの catch ブロックにて以下のメソッドを使用します。
import 'package:sixthsense/sixthsense.dart';
try {
throw StateError('try catch');
} catch (e, stack) {
sixthsense.reportHandledError(e, stack);
}

Android 用の設定

AndroidManifest.xml ファイルを使用してエージェントを設定することができます。

  1. application タグでアクセストークンを設定します。
<meta-data android:name="com.rakuten.sixthsense.ACCESS_TOKEN"
android:value="access-token-here"/>

アクセストークンは SixthSense のダッシュボードから確認可能です( [設定] → [一般] → [アクセストークン] ）

  1. 同様に、レポートのベース URL を設定します。
<meta-data android:name= "com.rakuten.sixthsense.BASE_URL"
android:value="https://http-collector-observability.sixthsense.rakuten.com/mobile"/> (for OneCloud Platform, use android:value="https://sixthsense-backend.jpe2-caas1-prod1.caas.jpe2b.r-local.net/mobile"/>)

モジュールレベルの build.gradle でプラグインを適用します。

apply plugin: "SSNetworkPlugin"

以下は、上記 Http クライアントの自動インストルメンテーションにおける要件です。

  • Android Gradleプラグイン - 7.1+
  • Gradleバージョン - 7.2+

iOS 用の設定

iOS 用のエージェントは、以下の手順で設定が可能です。

  1. X-Code で xcworkspace ファイルを開きます。
  2. Info.plist ファイルを開き、”AccessToken” キーを文字列として追加します。
  3. 同じ値を追加します。
  4. Info.plist ファイルを開きます。
  5. “国コード" キーを文字列として追加します。
  6. 国コードの値を追加します（例：日本の場合はJP、アメリカの場合はUS等）。
  7. Info.plist ファイルを開きます。
  8. ”エンドポイント” キーを文字列として追加します。
  9. 以下の値を追加します。 "https://http-collector-observability.sixthsense.rakuten.com/mobile/" （OneCloud Platformの場合は、以下の値を追加します。 "https://sixthsense-backend.jpe2-caas1-prod1.caas.jpe2b.r-local.net/mobile" ）