特定のアプリのコードにカスタム モニタリングを追加する

カスタム トレースを作成して、アプリ内の特定のコードに関連付けられたパフォーマンス データをモニタリングできます。カスタム トレースを使用すると、アプリが特定のタスクまたは一連のタスクを完了するのにかかる時間を測定できます。たとえば、一連の画像の読み込みやデータベースのクエリなどです。カスタム トレースのデフォルトの指標は期間ですが、カスタム指標も追加できます。

コードでは、Performance Monitoring SDK に用意された API を使用して、カスタム トレースの開始と終了を定義します。

トレースは作成後に開始することも可能で、スレッドセーフです。

ポイント:

  • アプリには複数のカスタム トレースを作成できます。
  • 複数のカスタム トレースを同時に実行できます。
  • カスタム トレースとカスタム指標の名前には制限があります。先頭または末尾が空白文字でなく、先頭がアンダースコア(_)でない 32 文字以下の名前にする必要があります。

デフォルト属性、カスタム属性、カスタム指標

カスタム トレースでは、Firebase コンソールでデータをフィルタリングできるように、どのタイプのトレースについても収集されるデフォルト属性(アプリのバージョン、国、デバイス、ブラウザなど該当するメタデータ)が自動的にログに記録されます。カスタム トレースではさらに、カスタム属性(ゲームレベルやユーザー プロパティなど)も追加してモニタリングできます。

カスタム トレースは、トレースの範囲内で発生したパフォーマンス関連イベントのカスタム指標を記録するように構成することもできます。たとえば、キャッシュのヒット数とミス数や、UI が一定の期間反応しなかった回数のカスタム指標を作成できます。これらのカスタム指標のデータは、トレースのデフォルト指標とともに Firebase コンソールに表示されます。

カスタム トレースとカスタム指標を追加する

Trace API を使用して、カスタム トレースとカスタム指標を追加し、特定のアプリケーション コードをモニタリングします。

  1. カスタム トレースを開始して停止するには、トレースするコードを次のようなコード行で囲みます。

    const trace = perf.trace('customTraceName');
    trace.start();
    
    // code that you want to trace
    
    trace.stop();
    

    詳しくは、カスタム トレース用 API をご覧ください。

  2. カスタム指標を追加するには、次のようなコード行を追加し、イベントが発生するたびに実行されるようにします。たとえば、このカスタム指標は、アプリで発生したパフォーマンス関連のイベントをカウントします。

    async function getInventory(inventoryIds) {
      const trace = perf.trace('inventoryRetrieval');
    
      // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
      trace.incrementMetric('numberOfIds', inventoryIds.length);
    
      // Measures the time it takes to request inventory based on the amount of inventory
      trace.start();
      const inventoryData = await retrieveInventory(inventoryIds);
      trace.stop();
    
      return inventoryData;
    }
    

コンソールでカスタム トレースとカスタム指標をモニタリングする

  1. Firebase コンソールで [Performance] ダッシュボードに移動します。

  2. [デバイス] タブでは次のような操作ができます。

    • すべてのページ読み込みトレース(および追加した任意のカスタム トレース)で収集されたデータのクイック レポートを表示できます。

    • 特定のトレースをクリックして、そのトレースのデータの詳細を確認できます。

    • ダッシュボードの左上にある [フィルタ ] ボタンを使用して、属性を基準にしたデータの基本フィルタを実行できます。

  3. 個別のトレースをクリックすると、収集されたデータの概要がコンソールの指標カードに表示されます。

    • ダッシュボードの右上にあるオプションを使用して、データを集約値または時系列の形式で表示できます。

    • ダッシュボードの左上にある [フィルタ ] ボタンを使用して、属性を基準にしたデータの基本フィルタを実行できます。

  4. どの指標についても、[もっと見る] をクリックすると、収集されたデータに関する詳細な情報を確認でき、高度な分析機能を使用できます。たとえば、属性を基準にしたデータのフィルタやセグメント化を行うことができます。

次のステップ