機能ロールアウトのパフォーマンス モニタリング

1. 概要

この Codelab では、機能のロールアウト中にアプリのパフォーマンスをモニタリングする方法を学びます。このサンプルアプリは基本的な機能を備えており、Firebase Remote Config のフラグに基づいて異なる背景画像を表示するように設定されています。トレースを計測してアプリのパフォーマンスをモニタリングし、構成変更をアプリに適用し、その影響をモニタリングして、パフォーマンスを向上させる方法を確認します。

学習内容

  • Firebase Performance Monitoring をモバイルアプリに追加して、すぐに使える指標(アプリの起動時間、遅いフレームやフリーズしたフレームなど)を取得する方法
  • カスタム トレースを追加してユーザー ジャーニーのクリティカル コードパスを把握する方法
  • Performance Monitoring ダッシュボードを使用して指標を理解し、機能のロールアウトなどの重要な変更を追跡する方法
  • パフォーマンス アラートを設定して主要な指標をモニタリングする方法
  • Firebase Remote Config の変更をロールアウトする方法

前提条件

  • Android Studio 4.0 以降
  • API レベル 16 以降を搭載した Android Emulator。
  • Java バージョン 8 以降
  • Firebase Remote Config に関する基礎知識

2. サンプル プロジェクトを設定する

コードをダウンロードする

次のコマンドを実行して、この Codelab のサンプルコードのクローンを作成します。マシンに codelab-perf-rc-android という名前のフォルダが作成されます。

$ git clone https://github.com/FirebaseExtended/codelab-feature-rollout-performance.git

マシンに Git がない場合は、GitHub からコードを直接ダウンロードすることもできます。

firebase-perf-rc-android-start フォルダ下のプロジェクトを Android Studio にインポートします。場合によっては、ランタイム例外や、google-services.json ファイルがないという警告が表示されます。これは次のセクションで修正します。

この Codelab では、Firebase Assistant プラグインを使用して Android アプリを Firebase プロジェクトに登録し、必要な Firebase 構成ファイル、プラグイン、依存関係を Android プロジェクトに追加します。これらはすべて、すべて Android Studio 内から行います。

アプリを Firebase に接続する

  1. [Android Studio] > [Help] > [Check for updates] に移動し、Android Studio と Firebase Assistant の最新バージョンを使用していることを確認します。
  2. [Tools] > [Firebase] を選択して、[Assistant] ペインを開きます。

c0e42ef063d21eab.png

  1. [Performance Monitoring] を選択してアプリに追加し、[Performance Monitoring を使ってみる] をクリックします。
  2. [Firebase に接続] をクリックして、Android プロジェクトを Firebase に接続します(これにより、ブラウザに Firebase コンソールが開きます)。
  3. Firebase コンソールで [プロジェクトを追加] をクリックし、Firebase プロジェクトの名前を入力します(すでに Firebase プロジェクトがある場合は、その既存のプロジェクトを選択することもできます)。[続行] をクリックし、利用規約に同意して、Firebase プロジェクトと新しい Firebase アプリを作成します。

新しい Firebase アプリを Android Studio プロジェクトに接続するためのダイアログが表示されます。

51a549ebde2fe57a.png

  1. [接続] をクリックします。
  2. Android Studio を開きます。[Assistant] ペインに、アプリが Firebase に接続したことを示す確認メッセージが表示されます。

40c24c4a56a45990.png

Performance Monitoring をアプリに追加する

Android Studio の [Assistant] ペインで、[Add Performance Monitoring to your app] をクリックします。

[Accept Changes] ダイアログが表示されます。その後、Android Studio はアプリを同期して、必要な依存関係がすべて追加されたことを確認します。

3046f3e1f5fea06f.png

最後に、Android Studio の [Assistant] ペインに、すべての依存関係が正しく設定されていることを示す成功メッセージが表示されます。

62e79fd18780e320.png

追加の手順として、「(省略可)デバッグ ロギングを有効にする」の手順に沿ってデバッグ ロギングを有効にします。同じ手順は、一般公開ドキュメントにも記載されています。

3. アプリを実行する

アプリのモジュール(アプリレベル)ディレクトリに google-services.json ファイルが表示され、アプリがコンパイルされるはずです。Android Studio で [Run] > [Run 'app'] をクリックし、Android Emulator でアプリをビルドして実行します。

アプリを実行すると、まず次のようなスプラッシュ画面が表示されます。

ffbd413a6983b205.png

数秒後、デフォルトの画像を含むメインページが表示されます。

d946cab0df319e50.png

内部の仕組み

スプラッシュ画面は SplashScreenActivity に実装され、次の処理を行います。

  1. onCreate() で、Firebase Remote Config の設定を初期化し、この Codelab の後半で Remote Config ダッシュボードに設定する構成値を取得します。
  2. executeTasksBasedOnRC() で、seasonal_image_url フラグの構成値を読み取ります。config 値で URL が指定されている場合、画像は同期的にダウンロードされます。
  3. ダウンロードが完了すると、アプリは MainActivity に移動し、finish() を呼び出して SplashScreenActivity を終了します。

MainActivity では、Remote Config を通じて seasonal_image_url が定義されている場合、この機能は有効になり、ダウンロードした画像がメインページの背景として表示されます。それ以外の場合は、デフォルトの画像(上図)が表示されます。

4. Remote Config をセットアップする

アプリが実行されるようになったので、新機能のフラグを設定できます。

  1. Firebase コンソールの左側のパネルで [エンゲージメント] セクションを見つけ、[Remote Config] をクリックします。
  2. [構成を作成] ボタンをクリックして構成フォームを開き、seasonal_image_url をパラメータキーとして追加します。
  3. [説明を追加] をクリックして、説明「Shows a seasonal image (replaces default) in the main page when the restaurant list is empty.」を入力します。
  4. [新たに追加] -> [条件値] -> [新しい条件を作成] をクリックします。
  5. 条件名として「Seasonal image rollout」と入力します。
  6. [Applies if...] セクションで [User in random percentile <= 0%] を選択します。(この機能は、後のステップでロールアウトする準備ができるまで無効にしたままにします)。
  7. [条件を作成] をクリックします。この条件は、後でユーザーに新機能を展開するときに使用します。

7a07526eb9e81623.png

  1. [最初のパラメータを作成する] フォームを開き、[季節限定の画像ロールアウトの値] フィールドを見つけます。季節の画像をダウンロードする URL(https://images.unsplash.com/photo-1552691021-7043334e0b51)を入力します
  2. デフォルト値を空の文字列のままにします。つまり、URL からダウンロードされた画像ではなく、コードベースのデフォルトの画像が表示されます。
  3. [保存] をクリックします。

99e6cd2ebcdced.png

新しい構成がドラフトとして作成されていることがわかります。

  1. [変更を公開] をクリックし、上部で変更を確認してアプリを更新します。

39cd3e96d370c7ce.png

5. データ読み込み時間のモニタリングを追加する

アプリは、MainActivity を表示する前に一部のデータをプリロードし、このプロセスを非表示にするためにスプラッシュ画面を表示します。この画面でユーザーが長時間待たされることがないよう、通常はスプラッシュ画面の表示時間をモニタリングすることをおすすめします。

それを実現するのが Firebase Performance Monitoring です。カスタム コード トレースを計測可能にして、データの読み込み時間や新機能の処理時間など、アプリ内の特定のコードのパフォーマンスをモニタリングできます。

スプラッシュ画面の表示時間をトラッキングするには、スプラッシュ画面を実装する Activity である SplashScreenActivity にカスタムコード トレースを追加します。

  1. splash_screen_trace という名前のカスタムコード トレースを初期化、作成、開始します。

SplashScreenActivity.java

// ...
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;
// ...

public class SplashScreenActivity extends AppCompatActivity {

    private static final String TAG = "SplashScreenActivity";
    private static final String SEASONAL_IMAGE_URL_RC_FLAG = "seasonal_image_url";

    // TODO: Initialize splash_screen_trace
    private final Trace splashScreenTrace = FirebasePerformance.startTrace("splash_screen_trace");
    
    // ...
}
  1. SplashScreenActivityonDestroy() メソッドでトレースを終了します。

SplashScreenActivity.java

@Override
protected void onDestroy() {
    super.onDestroy();

    // TODO: Stop the splash_screen_trace here
    splashScreenTrace.stop();
}

新しい機能が画像をダウンロードして処理するため、機能が SplashScreenActivity に追加された時間を追跡する 2 つ目のカスタムコード トレースを追加します。

  1. splash_seasonal_image_processing という名前のカスタムコード トレースを初期化、作成、開始します。

SplashScreenActivity.java

private void executeTasksBasedOnRC(FirebaseRemoteConfig rcConfig) {
    String seasonalImageUrl = rcConfig.getString(SEASONAL_IMAGE_URL_RC_FLAG);
    Log.d(TAG, SEASONAL_IMAGE_URL_RC_FLAG + ": " + seasonalImageUrl);

    if (!seasonalImageUrl.isEmpty()) {
        // TODO: Start the splash_seasonal_image_processing here
        final Trace seasonalImageProcessingTrace = FirebasePerformance
            .startTrace("splash_seasonal_image_processing");

        // ...
    }
}
  1. RequestListeneronLoadFailed() メソッドと onResourceReady() メソッドの両方でトレースを終了します。

SplashScreenActivity.java

Glide.with(SplashScreenActivity.this.getApplicationContext())
    .asBitmap()
    .load(seasonalImageUrl)
    .signature(new ObjectKey(Utils.getCacheUUID()))
    .listener(new RequestListener<Bitmap>() {
        @Override
        public boolean onLoadFailed(
            @Nullable GlideException e,
            Object model, Target<Bitmap> target,
            boolean isFirstResource) {

            // TODO: Stop the splash_seasonal_image_processing here
            seasonalImageProcessingTrace.stop();

            launchMainActivity();
            return true;
        }

        @Override
        public boolean onResourceReady(Bitmap resource, Object model,
            Target<Bitmap> target, DataSource dataSource,
            boolean isFirstResource) {

            // TODO: Stop the splash_seasonal_image_processing here
            seasonalImageProcessingTrace.stop();

            launchMainActivity();
            return true;
        }
     })
     .preload();

スプラッシュ画面の継続時間(splash_screen_trace) と新機能の処理時間(splash_seasonal_image_processing))をトラッキングするカスタムコード トレースを追加したら、Android Studio で再度アプリを実行します。Logging trace metric: splash_screen_trace とトレース継続時間を含むロギング メッセージが表示されます。新機能をまだ有効にしていないため、splash_seasonal_image_processing のログメッセージは表示されません。

6. トレースにカスタム属性を追加する

カスタムコード トレースでは、Performance Monitoring によってデフォルトの属性(アプリのバージョン、国、デバイスなどの一般的なメタデータ)が自動的にログに記録され、Firebase コンソールでトレースするデータをフィルタできます。カスタム属性を追加してモニタリングすることもできます。

アプリに 2 つのカスタムコード トレースを追加して、スプラッシュ画面の時間と新機能の処理時間をモニタリングしました。これらの表示時間に影響を与える要因は、表示される画像がデフォルトの画像かどうか、または URL から画像をダウンロードする必要があるかどうかです。画像をダウンロードする URL が違ってくるかもしれません。

そこで、季節的な画像 URL を表すカスタム属性をこれらのカスタムコード トレースに追加しましょう。これにより、後でこれらの値で所要時間データをフィルタできます。

  1. executeTasksBasedOnRC メソッドの先頭に splash_screen_trace のカスタム属性(seasonal_image_url_attribute)を追加します。

SplashScreenActivity.java

private void executeTasksBasedOnRC(FirebaseRemoteConfig rcConfig) {
    String seasonalImageUrl = rcConfig.getString(SEASONAL_IMAGE_URL_RC_FLAG);
    Log.d(TAG, SEASONAL_IMAGE_URL_RC_FLAG + ": " + seasonalImageUrl);

    // TODO: Add a custom attribute "seasonal_image_url_attribute" to splash_screen_trace
    if (seasonalImageUrl.isEmpty()) {
        splashScreenTrace.putAttribute("seasonal_image_url_attribute", "unset");
    } else {
        splashScreenTrace.putAttribute("seasonal_image_url_attribute", seasonalImageUrl);
    }

    // ...
}
  1. startTrace("splash_seasonal_image_processing") 呼び出しの直後に、splash_seasonal_image_processing に同じカスタム属性を追加します。

SplashScreenActivity.java

if (!seasonalImageUrl.isEmpty()) {
    // TODO: Start the splash_seasonal_image_processing here
    final Trace seasonalImageProcessingTrace = FirebasePerformance
        .startTrace("splash_seasonal_image_processing");

    // TODO: Add a custom attribute "seasonal_image_url_attribute" to splash_seasonal_image_processing
    seasonalImageProcessingTrace
        .putAttribute("seasonal_image_url_attribute", seasonalImageUrl);

    // ...
}

カスタム トレース(splash_screen_tracesplash_seasonal_image_processing)の両方にカスタム属性(seasonal_image_url_attribute)を追加したら、Android Studio でもう一度アプリを実行します。「Setting attribute 'seasonal_image_url_attribute' to 'unset' on trace 'splash_screen_trace'.」というログ メッセージが表示されます。Remote Config のパラメータ seasonalImageUrl をまだ有効にしていないため、属性値が unset になっています。

Performance Monitoring SDK がトレースデータを収集して Firebase に送信します。データは Firebase コンソールのパフォーマンス ダッシュボードで確認できます。このダッシュボードについては、Codelab の次のステップで詳しく説明します。

7. Performance Monitoring ダッシュボードを構成する

特徴をモニタリングするようにダッシュボードを構成する

Firebase コンソールで、Friendly Eats アプリがあるプロジェクトを選択します。

左側のパネルで [リリースとモニタリング] セクションを見つけ、[パフォーマンス] をクリックします。

指標ボードの最初のデータポイントを含むパフォーマンス ダッシュボードが表示されるはずです。Performance Monitoring SDK はアプリからパフォーマンス データを収集し、収集後数分以内にそのデータを表示します。

f57e5450b70034c9.png

この指標ボードでは、アプリの主要な指標を追跡できます。デフォルトのビューにはアプリの起動時間トレースの期間が含まれていますが、最も重視する指標を追加できます。追加した新しい特徴をトラッキングしているので、ダッシュボードをカスタマイズして、カスタムコード トレース splash_screen_trace の期間を表示できます。

  1. 空の [指標を選択] ボックスのいずれかをクリックします。
  2. ダイアログ ウィンドウで、トレースタイプとして [カスタム トレース] とトレース名 [splash_screen_trace] を選択します。

1fb81f4dba3220e0.png

  1. [指標を選択] をクリックすると、splash_screen_trace がダッシュボードに追加されたことがわかります。

同じ手順で他の重要な指標を追加することもできます。これにより、パフォーマンスの推移やリリースごとの変化をすばやく確認できます。

1d465c021e58da3b.png

指標ボードは、ユーザーが経験する主要な指標のパフォーマンスを追跡するための強力なツールです。この Codelab では、限られた期間のデータセットを使用するため、他のダッシュボード ビューを使用して、機能のロールアウトのパフォーマンスを把握できるようにします。

8. 機能をロールアウトする

以上でモニタリングの設定が完了し、Firebase Remote Config の変更(先ほど設定した seasonal_image_url))をロールアウトする準備が整いました。

変更をロールアウトするには、Firebase コンソールの [Remote Config] ページに戻り、ターゲティング条件のユーザー パーセンタイルを増やします。通常は、ごく一部のユーザーに新機能をロールアウトし、問題がないと確信が持てる場合にのみ、機能を増やします。ただし、この Codelab ではアプリのユーザーが 1 人だけなので、パーセンタイルを 100% に変更できます。

  1. ページの上部にある [条件] タブをクリックします。
  2. 先ほど追加した Seasonal image rollout 条件をクリックします。
  3. パーセンタイルを 100% に変更します。
  4. [Save Condition] をクリックします。
  5. [変更を公開] をクリックして変更を確定します。

70f993502b27e7a0.png

Android Studio に戻り、エミュレータでアプリを再起動して新機能を確認します。スプラッシュ画面の後に、新しい空の状態のメイン画面が表示されます。

b0cc91b6e48fb842.png

9. パフォーマンスの変化を確認する

次に、Firebase コンソールのパフォーマンス ダッシュボードを使用して、スプラッシュ画面の読み込みのパフォーマンスを確認しましょう。Codelab のこのステップでは、ダッシュボードのさまざまな部分を使用して、パフォーマンス データを表示します。

  1. メインの [ダッシュボード] タブでトレース テーブルまでスクロールし、[カスタム トレース] タブをクリックします。この表には、先ほど追加したカスタムコード トレースと、すぐに使用できるトレースが表示されます。
  2. 新機能を有効にしたので、カスタムコード トレース splash_seasonal_image_processing を探します。これは、画像をダウンロードして処理するのにかかった時間を測定したものです。トレースの [Duration] 値から、このダウンロードと処理にかなりの時間がかかることがわかります。

439adc3ec71805b7.png

  1. splash_seasonal_image_processing のデータがあるため、[Dashboard] タブの上部にある指標ボードにこのトレースの期間を追加できます。

前と同様に、空の [指標を選択] ボックスのいずれかをクリックします。ダイアログ ウィンドウで、トレースタイプとして [カスタム トレース] とトレース名 [splash_seasonal_image_processing] を選択します。最後に、[指標を選択] をクリックして、この指標を指標ボードに追加します。

7fb64d2340410576.png

  1. 違いを詳しく確認するには、splash_screen_trace のデータの詳細をご覧ください。指標ボードの splash_screen_trace カードをクリックし、[指標の詳細を表示] をクリックします。

b1c275c30679062a.png

  1. 詳細ページの左下に、前に作成したカスタム属性を含む属性のリストが表示されます。カスタム属性 seasonal_image_url_attribute をクリックすると、右側に各シーズン画像の URL のスプラッシュ画面の表示時間が表示されます。

8fa1a69019bb045e.png

  1. スプラッシュ画面の持続時間は、おそらく上のスクリーンショットと多少異なりますが、デフォルト画像(「未設定」で表示)を使用する場合よりも、画像を URL からダウンロードする場合よりも時間を長くする必要があります。

この Codelab では、この時間が長くなる理由は単純明快ですが、実際のアプリではそれほど明白ではないかもしれません。収集された所要時間のデータは、さまざまなデバイスから取得され、さまざまなネットワーク接続状況でアプリを実行しており、これらの状況は予想より悪くなる可能性があります。これが現実にあった場合、この問題をどのように調査するかを見ていきましょう。

  1. ページの上部にある [パフォーマンス] をクリックして、[ダッシュボード] のメインタブに戻ります(640b696b79d90103.png)。
  2. ページの下部にあるトレース テーブルで、[ネットワーク リクエスト] タブをクリックします。この表には、アプリからのすべてのネットワーク リクエストが URL パターンに集計されて images.unsplash.com/** URL パターンも含めて表示されます。このレスポンス時間の値を、画像のダウンロードと処理に要する全体時間(つまり、splash_seasonal_image_processing トレースの期間)と比較すると、画像のダウンロードに多くの時間が費やされていることがわかります。

6f92ce0f23494507.png

パフォーマンスに関する検出結果

Firebase Performance Monitoring を使用して、この新機能を有効にするとエンドユーザーに次のような影響があることがわかりました。

  1. SplashScreenActivity の利用時間が増加しました。
  2. splash_seasonal_image_processing の長さが非常に長いため、
  3. この遅延の原因は、画像のダウンロードに要する応答時間と、それに対応する画像の処理時間でした。

次のステップでは、機能をロールバックして、機能の実装を改善する方法を特定することで、パフォーマンスへの影響を軽減します。

10. 機能をロールバックする

スプラッシュ画面の待ち時間を長くすることは望ましくありません。Remote Config の主なメリットの 1 つは、ユーザーに別のバージョンをリリースすることなく、公開を一時停止して元に戻せることです。これにより、問題(前のステップで発見したパフォーマンスの問題など)に迅速に対応し、不満のあるユーザーの数を最小限に抑えることができます。

迅速な緩和策として、ロールアウトのパーセンタイルを 0 にリセットして、すべてのユーザーにデフォルトのイメージが再び表示されるようにします。

  1. Firebase コンソールの [Remote Config] ページに戻ります。
  2. ページの上部にある [条件] をクリックします。
  3. 先ほど追加した Seasonal image rollout 条件をクリックします。
  4. パーセンタイルを 0% に変更します。
  5. [Save Condition] をクリックします。
  6. [変更を公開] をクリックして変更を確定します。

18c4f1cbac955a04.png

Android Studio でアプリを再起動すると、元の空の状態のメイン画面が表示されます。

d946cab0df319e50.png

11. パフォーマンスの問題を解決する

Codelab で先に、スプラッシュ画面の画像をダウンロードすると、アプリの速度が低下することがわかりました。ダウンロードした画像を詳しく見てみると、2 MB を超える画像の元の解像度を使用していることがわかります。パフォーマンスの問題への簡単な解決策の 1 つは、画質をより適切な解像度に下げて、画像のダウンロード時間を短縮することです。

Remote Config の値を再度ロールアウトする

  1. Firebase コンソールの [Remote Config] ページに戻ります。
  2. seasonal_image_url パラメータの [編集] アイコンをクリックします。
  3. [季節的な画像ロールアウトの値] を https://images.unsplash.com/photo-1552691021-7043334e0b51?w=640 に更新し、[保存] をクリックします。

828dd1951a2ec4a4.png

  1. ページの上部にある [条件] タブをクリックします。
  2. [季節に応じた画像のロールアウト] をクリックして、パーセンタイルを 100% に戻します。
  3. [Save Condition] をクリックします。

1974fa3bb789f36c.png

  1. [変更を公開] ボタンをクリックします。

12. 修正をテストし、アラートを設定する

アプリをローカルで実行する

別のダウンロード イメージ URL を使用するように新しい構成値を設定し、アプリを再度実行します。今回は、スプラッシュ画面の表示時間が以前よりも短くなっていることがわかります。

b0cc91b6e48fb842.png

変更のパフォーマンスを確認する

Firebase コンソールのパフォーマンス ダッシュボードに戻り、指標がどのように表示されているかを確認します。

  1. 今回は、トレース テーブルを使用して詳細ページに移動します。トレース テーブルの [カスタム トレース] タブでカスタム トレース splash_seasonal_image_processing をクリックすると、期間の指標の詳細が再度表示されます。

2d7aaca03112c062.png

  1. カスタム属性 seasonal_image_url_attribute をクリックすると、カスタム属性の内訳が再び表示されます。URL にカーソルを合わせると、縮小画像の新しい URL と一致する値 https://images.unsplash.com/photo-1552691021-7043334e0b51?w=640(末尾に ?w=640)が表示されます。この画像に関連付けられている再生時間の値は、前の画像の値よりもかなり短く、ユーザーにとって許容範囲内です。

10e30c037a4237a2.png

  1. スプラッシュ画面のパフォーマンスが向上したので、設定したしきい値をトレースが超えたときに通知するようにアラートを設定できます。パフォーマンス ダッシュボードを開き、splash_screen_trace のオーバーフロー メニュー(その他アイコン)をクリックして、[アラート設定] をクリックします。

4bd0a2a1faa14479.png

  1. 切り替えボタンをクリックして、[期間] のアラートを有効にします。現在表示されている値よりも少し高い値をしきい値に設定して、splash_screen_trace がしきい値を超えた場合にメールが届きます。
  1. [保存] をクリックしてアラートを作成します。トレース テーブルまで下にスクロールし、[カスタム トレース] タブをクリックして、アラートが有効になっていることを確認します。

2bb93639e2218d1.png

13. お疲れさまでした

これでFirebase Performance Monitoring SDK を有効にしてトレースを収集し、新機能のパフォーマンスを測定しました。新機能のロールアウトに向けて主要なパフォーマンス指標をモニタリングし、パフォーマンスの問題が発見された場合に迅速に対応しました。これらはすべて、Remote Config を使用して構成を変更し、リアルタイムでパフォーマンスの問題をモニタリングすることで実現できます。

学習した内容

  • アプリに Firebase Performance Monitoring SDK を追加する
  • カスタムコード トレースをコードに追加して特定の機能を測定する
  • 新機能を制御/ロールアウトするための Remote Config のパラメータと条件値の設定
  • パフォーマンス モニタリング ダッシュボードを使用してロールアウト中の問題を特定する方法を理解する
  • アプリのパフォーマンスが設定したしきい値を超えた場合に通知するように、パフォーマンス アラートを設定する

詳細