Performance Monitoring についてのトラブルシューティングとよくある質問

このページでは、Performance Monitoring の使用を開始する際や、Performance Monitoring の機能とツールを使用する際のトラブルシューティングのヒントを紹介します。

トラブルシューティングのための最初の確認

トラブルシューティングを行う前に、次の 2 つの点を確認することをおすすめします。

1. パフォーマンスイベントのログメッセージを確認する

ログメッセージを確認して、Performance Monitoring SDK がパフォーマンスイベントをキャプチャしていることを確認します。

パフォーマンスイベントのログメッセージを表示する方法

ブラウザのデベロッパーツール（Chrome デベロッパーツールの [ネットワーク] タブや Firefox のネットワークモニターなど）を開きます。
ブラウザでウェブアプリを更新します。
ログメッセージにエラーメッセージがないか確認します。
数秒後、ブラウザのデベロッパーツールで、firebaselogging.googleapis.com に対するネットワーク呼び出しを確認します。ネットワーク呼び出しが存在する場合、ブラウザがパフォーマンスデータを Firebase に送信しています。

アプリがパフォーマンスイベントをロギングしていない場合は、トラブルシューティングのヒントをご覧ください。

2. Firebase ステータスダッシュボードを確認する

Firebase または Performance Monitoring に既知の停止が発生しているかどうか、Firebase ステータスダッシュボードを確認します。

Performance Monitoring を使ってみる

Performance Monitoring（iOS+ | Android | Web）、の使用を開始するうえで、Firebase が SDK を検出したり、Firebase コンソールに最初のパフォーマンスデータを表示したりする際に問題が発生した場合は、次のトラブルシューティングのヒントを参考にしてください。

SDK をアプリに追加したが、SDK を追加するようコンソールに指示が表示される

Firebase は、アプリからイベント情報（アプリの操作など）を受け取るときに、アプリに Performance Monitoring SDK が正常に追加されたかどうかを検出できます。通常、アプリを起動してから 10 分以内に、Firebase コンソールのパフォーマンス ダッシュボードに「SDK を検出しました」というメッセージが表示されます。30 分以内に、最初の処理済みのデータがダッシュボードに表示されます。

最新バージョンの SDK をアプリに追加してから 10 分以上経過しても変化が現れない場合は、ログメッセージを確認して、Performance Monitoring がイベントをロギングしているか確認します。以下の該当するトラブルシューティングの手順を試して、SDK 検出メッセージの遅延についてトラブルシューティングを行います。

アプリがイベントをロギングしている: トラブルシューティングの手順

ローカルで開発している場合は、データ収集用のイベントをさらに生成してみてください。
1. ローカル環境でウェブアプリを提供および表示します。
2. サイトのサブページを読み込んだり、アプリを操作したり、ネットワークリクエストをトリガーしたりして、イベントを生成します。ページが読み込まれた後、ブラウザのタブを 10 秒以上開いたままにします。
Firebase 構成オブジェクトがアプリに正しく追加され、オブジェクトを変更していないことを確認します。具体的には、次の点を確認します。
- 構成オブジェクト内の Firebase ウェブアプリ ID（appId）がアプリに適していること。 プロジェクト設定のアプリカードで Firebase アプリ ID を確認します。
アプリの構成オブジェクトに問題があると思われる場合は、次の手順をお試しください。
1. 現在アプリに設定されている構成オブジェクトを削除します。
2. こちらの手順に沿って新しい構成オブジェクトを取得し、ウェブアプリに追加します。
SDK がイベントをロギングしていて、すべてが正しく設定されているにもかかわらず、2 時間経過しても SDK 検出メッセージや処理済みデータが表示されない場合は、Firebase サポートにお問い合わせください。

アプリがイベントをロギングしていない: トラブルシューティングの手順

アプリで Performance Monitoring SDK が正しく初期化されていることを確認します。
次のフラグによって Performance Monitoring SDK が無効になっていないことを確認します。
- performance.instrumentationEnabled
ブラウザキャッシュが無効になっていることを確認します。無効でない場合、ブラウザは新しい計測設定を取得しない場合があります。
ウェブページのタブを閉じてからもう一度開きます。再度ロギングを確認します。

アプリに Performance Monitoring SDK を追加したばかりの場合は、SDK が機能するようにアプリを完全に再起動する必要がある場合があります。
アプリで無効になっているものが見つからない場合は、Firebase サポートにお問い合わせください。

SDK を検出したとコンソールに表示されるが、データが表示されない

Performance Monitoring がパフォーマンスイベントデータを処理した後に、パフォーマンス ダッシュボードにそのデータが表示されます。

「SDK を検出しました」というメッセージが表示されてから 24 時間以上経過してもデータが表示されない場合は、既知の停止が発生しているかどうか Firebase ステータスダッシュボードを確認します。停止が発生していない場合は、Firebase サポートにお問い合わせください。

一般的なトラブルシューティング

SDK を正常に追加し、アプリで Performance Monitoring を使用している場合、Performance Monitoring の機能とツールに関する一般的な問題には次のトラブルシューティングのヒントが役立ちます。

アプリがパフォーマンスイベントをロギングしない

パフォーマンスイベントのログメッセージが表示されない場合は、次のトラブルシューティング手順をお試しください。

アプリで Performance Monitoring SDK が正しく初期化されていることを確認します。
次のフラグによって Performance Monitoring SDK が無効になっていないことを確認します。
- performance.instrumentationEnabled
ブラウザキャッシュが無効になっていることを確認します。無効でない場合、ブラウザは新しい計測設定を取得しない場合があります。
ウェブページのタブを閉じてからもう一度開きます。再度ロギングを確認します。

アプリに Performance Monitoring SDK を追加したばかりの場合は、SDK が機能するようにアプリを完全に再起動する必要がある場合があります。
アプリで無効になっているものが見つからない場合は、Firebase サポートにお問い合わせください。

パフォーマンスダッシュボードに初回入力遅延データが表示されない

初回入力遅延指標のデータが表示されない場合は、次のトラブルシューティング手順をお試しください。

Performance Monitoring が初回入力遅延指標を記録するのは、ページの読み込み後 5 秒以内にウェブページをクリックした場合のみであることに注意してください。
この指標を測定するようにアプリを設定していることを確認します。初回入力遅延指標には手動設定が必要です。具体的には、この指標にポリフィルライブラリを追加する必要があります。インストール方法については、ライブラリのドキュメントをご覧ください。

このポリフィルライブラリを追加しなくても、Performance Monitoring は他のウェブアプリ指標を報告できます。

パフォーマンスダッシュボードにカスタムトレースデータが表示されない

自動収集されるトレースのパフォーマンスデータは表示され、カスタムコードトレースのデータは表示されませんか。次のトラブルシューティング手順をお試しください。

Trace API を使用してインストルメント化したカスタムコードトレースの設定を確認します。特に次の点に注意してください。
- カスタムコードトレースとカスタム指標の名前には制限があります。先頭または末尾が空白文字でなく、先頭がアンダースコア（_）でない 32 文字以下の名前を指定する必要があります。
- すべてのトレースを開始して停止する必要があります。開始されていないトレース、停止されていないトレース、開始前に停止されたトレースはログに記録されません。
record() メソッドを使用している場合は、トレースを明示的に開始または停止する必要はありません。
次のフラグによってPerformance Monitoring データ収集が無効になっていないことを確認します。
- performance.dataCollectionEnabled
  
  このフラグは、すべてのデータではなく、カスタムコードトレースのデータ収集のみを制御します。
ログメッセージを確認して、Performance Monitoring が、想定されるカスタムコードトレースをロギングしていることを確かめます。
Performance Monitoring がイベントをロギングしているが、24 時間経過してもデータが表示されない場合は、Firebase サポートにお問い合わせください。

パフォーマンスダッシュボードにネットワークリクエストデータが表示されない

ネットワークリクエストデータが表示されない場合は、次の点に注意してください。

Performance Monitoring は、ブラウザ API によって報告されたネットワークリクエストの指標を自動的に収集します。これらのレポートには、失敗したネットワークリクエストは含まれません。
コードとそのコードで使用しているネットワーキングライブラリの動作によっては、Performance Monitoring で報告されるのが、完了したネットワークリクエストだけになることがあります。この場合、開いたままの HTTP/S 接続が報告されていない可能性があります。

ネットワークリクエストデータが想定どおりに集計されない

詳細については、URL パターンで Performance Monitoring がネットワークリクエストデータを集計する方法をご覧ください。

カスタム URL パターンもお試しください。

よくある質問

プロジェクトホームのパフォーマンスカードの [問い合わせが多い問題] はどうなったのですか？

[問い合わせが多い問題] は、[最近のアラート] に置き換えられました。これは、設定したしきい値を超えると自動的に通知されるアラートを、最近導入したことを反映したものです。「問題」のサポートは終了し、アラートに置き換えられました。

パフォーマンスカードの上部にあるアプリセレクタでは、[最近のアラート] でアラートエントリがフィルタされます。選択したアプリについて、直近 3 件のアラートのみが表示されます。

アラートについて詳しくは、パフォーマンスの問題に関するアラートを設定するをご覧ください。

コンソールで問題に対してしきい値を設定する機能は、現在どうなっていますか？

Performance Monitoring は、定義したしきい値を超える指標に対するアラートをサポートしています。パフォーマンス指標に対するこれらの構成可能なしきい値との混同を回避するため、問題に対してしきい値を構成する機能は削除されています。

Firebase コンソールの [詳細] と [指標] の情報はどうなったのですか？

詳細ページと指標ページが一新され、新たに再設計され、一元化されたユーザーインターフェース（UI）に置き換えられました。これにより、問題のトラブルシューティングが向上します。この新しいトラブルシューティングの UI は、詳細や指標と同じコア機能を提供します。トラブルシューティングの詳細については、特定のトレースのデータをさらに表示するをご覧ください。

サンプル数が想定した数と異なるのはなぜですか？

Performance Monitoring は、アプリのユーザーデバイスからパフォーマンスデータを収集します。多くのユーザーがアプリを利用している場合や、アプリが大量のパフォーマンスアクティビティを生成する場合は、処理するイベントの数を減らすために、Performance Monitoring はデバイスのサブセットのみに限定してデータを収集することがあります。このように制限しても十分なデータが得られるため、イベントが少なくなったとしても、指標の値はユーザーのアプリエクスペリエンスを適切に表しています。

収集するデータの量を管理するために、Performance Monitoring は次のサンプリングオプションを使用します。

デバイス上のレート制限: デバイスが送信するトレースが急増することがないように、デバイスから送信されるコードトレースとネットワークリクエストトレースの数を 10 分間あたり 300 イベントに制限しています。このアプローチにより、大量のパフォーマンスデータを送信する可能性があるループ型のインストルメンテーションからデバイスを保護し、1 つのデバイスによってパフォーマンスの測定値が歪められるのを防ぎます。
動的サンプリング: Performance Monitoring は、1 つのアプリで、すべてのアプリユーザーを通じてコードトレースとネットワークリクエストトレースについてそれぞれ最大で約 1 億件のイベントを毎日収集します。（Firebase Remote Config を使用して）デバイスに関する動的サンプリングレートを取得し、ランダムなデバイスでトレースをキャプチャして送信する必要があるかどうかを判断します。サンプリングの対象として選択されていないデバイスはイベントを送信しません。動的サンプリングレートはアプリに固有であり、収集されるデータの全体量が制限を下回るように調整されます。

ユーザーセッションでは、ユーザーのデバイスからさらに多くの詳細なデータを送信します。そのため、データをキャプチャして送信するために必要となるリソースが増えます。ユーザーセッションの影響を最小限に抑えるため、Performance Monitoring はセッション数を制限する場合もあります。
サーバーサイドのレート制限: アプリでサンプリングの制限を超えないようにするため、Performance Monitoring はサーバーサイドのサンプリングを使用して、デバイスから受信した一部のイベントを破棄する場合があります。この制限によって指標の有効性が変化することはありませんが、次のような小規模なパターンの変化が生じることがあります。
- トレースの数とコードが実行された回数が異なる場合があります。
- コード内で密接に結合している複数のトレースのサンプル数が異なる場合があります。

コンソールの [問題] タブはどうなったのですか？

[問題] タブに代わってアラートが導入されました。アラートは、設定したしきい値を超えると自動的に通知されます。これにより、しきい値のステータスを特定するために手動で Firebase コンソールを確認する必要がなくなりました。アラートについて詳しくは、パフォーマンスの問題に関するアラートを設定するをご覧ください。

コンソールの [デバイス] タブと [ネットワーク] タブはどうなったのですか？それらのページに表示されていたトレースを表示するにはどうすればよいですか？

Firebase コンソールの Performance Monitoring セクションが再設計され、主要な指標とすべてのトレースがまとめて [ダッシュボード] タブに表示されるようになりました。今回の再設計の一環として、[デバイス] ページと [ネットワーク] ページを削除しました。

[ダッシュボード] タブの下部にあるトレーステーブルには、[デバイス] タブと [ネットワーク] タブに表示されていた同じ情報がすべて含まれていますが、特定の指標の変化率でトレースを並べ替える機能など、一部の機能が追加されました。特定のトレースの指標とデータをすべて表示するには、トレーステーブル内のトレース名をクリックします。

トレースはトレーステーブルの次のサブタブに表示されます。

ネットワークリクエストトレース（すぐに使用できるものとカスタムの両方） - [ネットワークリクエスト] サブタブ
カスタムコードトレース - [カスタムトレース] サブタブ
アプリの起動、フォアグラウンドのアプリ、バックグラウンドアプリのトレース - [カスタムトレース] サブタブ
画面レンダリングトレース - [画面レンダリング] サブタブ
ページ読み込みトレース - [ページ読み込み] サブタブ

トレーステーブルの詳細と、指標やデータの表示については、コンソールの概要ページ（iOS+ | Android | ウェブ）をご覧ください。

遅いフレームやフリーズしたフレームの数が想定した数と異なるのはなぜですか？

レンダリングが遅いフレームとフリーズしたフレームは、想定される 60 Hz のデバイスリフレッシュレートで計算されます。デバイスのリフレッシュレートが 60 Hz 未満の場合は、1 秒間にレンダリングされるフレームが少なくなるため、各フレームでレンダリング時間が長くなります。レンダリング時間が長くなると、レンダリングが遅くなるフレームやフリーズするフレームが多くなるため、遅いフレームやフリーズしたフレームの報告が増えます。ただし、デバイスのリフレッシュレートが 60 Hz を超える場合は、各フレームでレンダリング時間が短くなります。これにより、遅いフレームやフリーズしたフレームが報告される回数が少なくなります。これは、Performance Monitoring SDK の現在の制限です。

軽量で名前空間付きの Performance Monitoring JS SDK（「スタンドアロン」SDK）をウェブアプリに追加するにはどうすればよいですか？

アプリで使用している Firebase プロダクトが Performance Monitoring だけで、次のことを行いたい場合は、スタンドアロンの Performance Monitoring SDK と以下の推奨ヘッダースクリプトを使用できます。

名前空間付きライブラリを使用する
SDK パッケージサイズを小さくする
ページが読み込まれるまで SDK の初期化を延期する

アプリにスタンドアロンの Performance Monitoring SDK を追加し、ページが読み込まれるまで初期化を延期するには、次の操作を行います。

次のスクリプトをインデックスファイルのヘッダーに追加します。
アプリの Firebase プロジェクト構成オブジェクトを追加します。

(function(sa,fbc){function load(f,c){var a=document.createElement('script');
a.async=1;a.src=f;var s=document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(a,s);}load(sa);
window.addEventListener('load',function(){firebase.initializeApp(fbc).performance()});
})(performance_standalone, firebaseConfig);

ここで

performance_standalone は 'https://www.gstatic.com/firebasejs/10.13.2/firebase-performance.js' です
firebaseConfig はアプリの Firebase 構成オブジェクトです。

上記のスクリプトはスタンドアロン SDK を非同期で読み込み、ウィンドウの onload イベントが発生した後で Firebase を初期化します。この方法では、SDK を初期化する時点でブラウザが読み込み指標をすでに報告しているため、SDK がページ読み込み指標に及ぼす影響が小さくなります。

スタンドアロンの Performance Monitoring SDK とヘッダースクリプトについて

このスタンドアロン SDK はサイズが小さくなるよう最適化されています。gzip で圧縮され、約 10 KB です。Firebase Performance Monitoring のすべての機能と Firebase コア SDK 機能の最小セットが含まれています。

Firebase Performance Monitoring は fetch API と Promise API を使用しますが、これらは古いブラウザでは使用できません。これらの API のポリフィルは標準の Firebase Performance Monitoring JS SDK に含まれていますが、サイズを小さくするため、スタンドアロン SDK には含まれていません。

ブラウザからページ読み込み指標を取得するため、Performance Monitoring SDK は Resource Timing API に部分的に依存しています。

次のスニペットはヘッダースクリプトの一部で、最後に SDK の初期化を延期しています。

(function(sdkSource, firebaseConfigObject) {
   function load(f, c) {
       // Creates a script tag to load the standalone SDK
       var sdkScript = document.createElement('script');

       // Sets it to an async script so that it doesn't interfere with page load
       sdkScript.async = 1;

       // Sets the source of the script
       sdkScript.src = f;

       // Inserts the script into the head of the page
       var s = document.getElementsByTagName('script')[0];
       s.parentNode.insertBefore(sdkScript, s);
   }

   // Calls the load method
   load(sdkSource);

   // Initializes the SDK only when the onload method is called
   window.addEventListener('load', function() {
       firebase.initializeApp(firebaseConfigObject).performance();
   });
})(performance_standalone, firebaseConfig);

ここで

performance_standalone は 'https://www.gstatic.com/firebasejs/10.13.2/firebase-performance-standalone.js' です。
firebaseConfig はアプリの Firebase 構成オブジェクトです。

ほぼリアルタイムのデータ処理と表示

「準リアルタイム」（またはニアリアルタイム）のパフォーマンスデータとは何ですか？

Firebase Performance Monitoring が収集されたパフォーマンスデータを適時処理すると、ほぼリアルタイムのデータが Firebase コンソールに表示されます。処理されたデータは、収集されて数分以内にコンソールに表示されるため、「ほぼリアルタイム」という言葉を使用しています。

ほぼリアルタイムのデータ処理を利用するには、リアルタイム対応の SDK バージョンをアプリで使用します。

準リアルタイムのパフォーマンスデータをアプリで取得するにはどうすればよいですか？

リアルタイムのデータ処理に対応した Performance Monitoring SDK のバージョンをアプリで使用するだけで、ほぼリアルタイムのデータ処理を利用できます。

リアルタイム対応の SDK のバージョンは次のとおりです。

iOS - v7.3.0 以降
tvOS - v8.9.0 以降
Android - v19.0.10 以降（または Firebase Android BoM v26.1.0 以降）
ウェブ - v7.14.0 以降

常に最新バージョンの SDK を使用することをおすすめします。ただし、上述のいずれのバージョンでも、Performance Monitoring でほぼリアルタイムのデータ処理が行われます。

どのバージョンの Performance Monitoring SDK がリアルタイムに対応していますか？

リアルタイムのデータ処理に対応している SDK のバージョンは次のとおりです。

iOS - v7.3.0 以降
tvOS - v8.9.0 以降
Android - v19.0.10 以降（または Firebase Android BoM v26.1.0 以降）
ウェブ - v7.14.0 以降

リアルタイム対応の SDK バージョンを使用するようにアプリを更新していないとどうなりますか？

リアルタイム対応の SDK バージョンをアプリで使用していない場合でも、Firebase コンソールにはアプリのパフォーマンスデータがすべて表示されます。ただし、パフォーマンスデータはデータの収集からおよそ 36 時間遅れて表示されます。

リアルタイム対応の SDK バージョンにアップデートしましたが、一部のユーザーは古いバージョンのアプリを使用しています。それらのユーザーのパフォーマンスデータも Firebase コンソールで引き続き表示されますか？

はい。アプリインスタンスで使用している SDK バージョンに関係なく、すべてのユーザーのパフォーマンスデータが表示されます。

ただし、最近（約 36 時間以内）のデータについては、リアルタイム対応の SDK バージョンを使用するアプリインスタンスのユーザーのデータが表示されます。一方、最近ではないデータには、すべてのバージョンのアプリのパフォーマンスデータが表示されます。

Firebase サポートへのお問い合わせ

Firebase サポートに連絡する場合は、必ず Firebase アプリ ID をお知らせください。Firebase アプリ ID は、 プロジェクト設定のアプリカードで確認します。