Flutter 向け Performance Monitoring を使ってみる

このクイックスタートでは、Flutter アプリのパフォーマンス特性を把握できるように Firebase Performance Monitoring を設定する方法について説明します。

始める前に

まだ行っていない場合は、Flutter プロジェクトで Firebase の構成と初期化を行います。

ステップ 1: Performance Monitoring をアプリに追加する

Flutter プロジェクトのルートディレクトリから、次のコマンドを実行して Performance Monitoring Flutter プラグインをインストールします。
```
flutter pub add firebase_performance
```
Flutter プロジェクトのルートディレクトリから、次のコマンドを実行します。
```
flutterfire configure
```
このコマンドを実行すると、Flutter アプリの Firebase 構成が最新の状態になります。Android では必要な Performance Monitoring Gradle プラグインがアプリに追加されます。
完了したら、Flutter プロジェクトを再ビルドします。
```
flutter run
```

Performance Monitoring SDK を追加すると、Firebase はアプリのライフサイクルに関連するデータ（アプリの起動時間など）と HTTP/S ネットワークリクエストのデータの収集を自動的に開始します。

Flutter では、自動画面レンダリングのパフォーマンスモニタリングを、個別の Flutter 画面で行うことはできません。1 つのビューコントローラがネイティブで Flutter アプリケーション全体をカプセル化するため、基盤となるネイティブの Firebase SDK は画面の遷移を認識しません。

ステップ 2: 初期データ表示用のパフォーマンスイベントを生成する

SDK がアプリに正常に追加されると、Firebase によりイベントの処理が開始されます。引き続きローカルで開発を行っている場合は、アプリを操作して、初期データの収集と処理用のイベントを生成します。

シミュレータまたはテストデバイスを使用してアプリの開発を続けます。
アプリをバックグラウンドとフォアグラウンドの間で数回切り替えたり、画面間を移動してアプリを操作したり、ネットワークリクエストをトリガーしたりして、イベントを生成します。
Firebase コンソールのパフォーマンスダッシュボードに移動します。初期データが数分以内に表示されます。

初期データが表示されない場合は、トラブルシューティングのヒントをご覧ください。

ステップ 3:（省略可）パフォーマンスイベントのログメッセージを表示する

ログメッセージにエラーメッセージがないか確認します。

Performance Monitoring は、ログメッセージをフィルタできるように、ログメッセージに次のタグを付けます。
- iOS+: Firebase/Performance
- Android: FirebasePerformance
Performance Monitoring がパフォーマンスイベントをロギングしていることを示す次の種類のログを確認します。
- Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
- Logging network request trace: URL
URL をクリックして Firebase コンソールでデータを表示します。ダッシュボードでデータが更新されるまでに少し時間がかかることがあります。

ステップ 4:（省略可）特定のコードのカスタムモニタリングを追加する

アプリの特定のコードに関連付けられたパフォーマンスデータをモニタリングするには、カスタムコードトレースを計測可能にします。

カスタムコードトレースを使用すると、一連の画像の読み込みやデータベースのクエリなど、アプリが特定のタスクや一連のタスクを完了するのにかかる時間を測定できます。カスタムコードトレースのデフォルトの指標は期間ですが、キャッシュヒットやメモリ警告などのカスタム指標を追加することもできます。

コードで、Performance Monitoring SDK に用意された API を使用して、カスタムコードトレースの開始と終了を定義（および必要なカスタム指標を追加）します。

これらの機能の詳細とアプリに追加する方法については、特定のコードにモニタリングを追加するをご覧ください。

ステップ 5: アプリをデプロイして結果を確認する

エミュレータと 1 つまたは複数のテストデバイスを使用して Performance Monitoring を検証したら、アプリのアップデートバージョンをユーザーにデプロイします。

Firebase コンソールのパフォーマンスダッシュボードでパフォーマンスデータをモニタリングできます。

次のステップ

Performance Monitoring によって自動的に収集されるデータの詳細を確認する。
- アプリのライフサイクルに関連するデータ（アプリの起動時間など）
- アプリによって発行された HTTP/S ネットワークリクエストのデータ
Firebase コンソールでパフォーマンスデータを表示、追跡、フィルタリングする。
カスタムコードトレースを計測可能にすることで、アプリ内の特定のタスクまたはワークフローのモニタリングを追加する。
属性を使用してパフォーマンスデータをフィルタリングする。