アプリケーションのプロファイル

Unity Profiler を使ってアプリケーションをプロファイルする場合、データを記録する方法は主に 3 つあります。

• ターゲットプラットフォームのプレイヤーでアプリケーションをプロファイルします。
• Unity エディターの再生モードでアプリケーションをプロファイルします。
• Unity エディターをプロファイルします。

アプリケーションの正確なタイミングを得るための最良の方法は、アプリケーションを公開する予定のエンドプラットフォームでプロファイルすることです。これにより、アプリケーションのパフォーマンスに影響を与えるものに関する、正確なタイミングを知ることができます。

ただし、アプリケーションのパフォーマンス要素を向上させたいと思うたびにアプリケーションをビルドすると時間がかかります。そこで、アプリケーションのパフォーマンスを素早く評価するために、エディターの再生モードで直接プロファイルすることができます。再生モードでのプロファイルは、実際のデバイス上でのアプリケーションのパフォーマンスを正確に反映するものではありませんが、最初にエンドプラットフォーム上でプロファイルした後に加えた変更によって、アプリケーションのパフォーマンスが改善されたかどうかを素早くチェックするのに便利なツールです。

Unity エディターは、再生モードで動作するときにアプリケーションと同じリソースを使用するため、アプリケーションのパフォーマンスに影響を与える可能性があります。そのため、エディターを個別にプロファイルして、使用するリソースを決定することもできます。これは、映画制作など、再生モードで使用するために設計されたアプリケーションの場合に特に有効です。

ターゲットプラットフォームでのアプリケーションのプロファイル

ターゲットのリリースプラットフォームでアプリケーションをプロファイルするには、ターゲットデバイスをネットワークに接続するか、ケーブルでコンピューターに直接接続します。また、IP アドレスを使ってデバイスに接続することもできます。アプリケーションは、Development Build としてのみのプロファイルできます。これを設定するには、Build Settings (メニュー： File > Build Settings) に移動し、アプリケーションのターゲットプラットフォームを選択し、Development Build の設定を有効にします。この設定を有効にすると、プロファイラーに関連する 2 つの設定 Autoconnect Profiler と Deep Profiling Support が利用可能になります。

Autoconnect Profiler 設定を有効にすると、Unity エディターはビルド処理中にビルドプレイヤーに IP アドレスをベイクします。プレイヤーを起動すると、ベイクした IP アドレスのエディターのプロファイラーに接続を試みます。

さらに、Deep Profiling Support 設定を有効にすると、ビルドされたプレイヤーの起動時に Unity が ディーププロファイリング を実行します。つまり、プロファイラーは、ProfilerMarker で明示的にラップされたコードのタイミングだけでなく、コードのすべての部分をプロファイルします。これは、アプリケーションの起動時間を詳細にプロファイルするのに便利です。ただし、これは、ビルドにわずかな負荷を加えます。

Profiler ウィンドウを使ってプレイヤーに接続

To use the Profiler to manually connect to a platform running your application, configure the settings in the Attach to Player dropdown. You can only do this if Autoconnect Profiler is disabled.

For a platform to appear in the Attach to Player dropdown, it must meet the following requirements:

• プラットフォームは、ローカルネットワーク上で表示されるか、ケーブルでローカルマシンに直接接続されている。
• The platform is running a Player that you built with the Development Build option enabled. For instructions on how to enable this setting for a platform, refer to Profile your application on a target platform.
• プラットフォームがプレイヤーを実行している。

The Attach to Player dropdown displays all Unity Players that Unity detects through the network or by direct connection. You can identify these Players by Player Name and the Product Name that is running the Player; for example, iPhonePlayer (My iPhone).

プレイヤーの IP アドレスを使って直接プレイヤーに接続することもできます。これを行うには、Attach to Player メニューを選択し、ドロップダウンで <Enter IP> を選択します。表示されたダイアログボックスで、接続したいプレイヤーの IP アドレスとポート(必須ではありません) を入力します。

アプリケーションのプロファイリング情報を収集するには、ドロップダウンメニューからプレイヤーを選択し、Record をクリックします。

アプリケーションの実行中に継続的にデータを収集するには、Player Settings の Run In Background 設定を有効にします (Edit > Project Settings > Player > Resolution and Presentation)。この設定を有効にすると、バックグラウンドでアプリケーションを実行し続ける場合でもプロファイラーはデータを収集します。これを無効にすると、プロファイラーは、 アプリケーションがアクティブなウィンドウで実行されている場合にのみデータを収集します。

Attach to Player 検索バーの使用

The Attach to Player dropdown includes a search bar that you can use to find information about your Player. You can search by Player Name or device category, for example Remote. When you search by category, the result displays all devices in that category.

開発プレイヤーの名前を選択すると、プロファイラーに表示されます。

Attach to Player プロパティ

各コラムには、情報がある場合は、以下のような情報が表示されます。

プロパティ	説明
Player Name	The name of the device that is running your application. To change this name, navigate to Edit > Preferences > Analysis > Profiler (macOS: Unity > Settings > Analysis > Profiler) and enter your desired name in the Custom Connection ID field. You can also set a Player Name set when you launch a Player from the command line using the -connection-id argument. For more information about the categories in this property, see Player name device categories
Product Name	これは、Project > PlayerSettings で設定したフィールドの値です。
IP	プレイヤーの IP アドレス。
Port	プレイヤーのポート。

プレイヤー名のデバイスカテゴリ

Player Name カテゴリには、特定のデバイスタイプに関する情報を表示する以下のカテゴリがあります。

プロパティ	説明
Play Mode	再生モードでアプリケーションをプロファイルする場合は、このプロパティを選択します。
Edit Mode	このプロパティを選択すると、Unity エディターをプロファイルします。
Local	このリストには、ローカルマシン、Unity エディター、スタンドアロンプレイヤーで動作しているあらゆるデバイスが含まれます。 また、ホストマシンにケーブルで物理的に接続されているプレイヤーの情報も表示されます。
Remote	このセクションは、ローカルネットワーク上で動作しているデバイスの情報を表示します。 このセクションは、Unity がローカルネットワーク上で動作しているリモートデバイスを検出した場合にのみ表示されます。
Connections without ID	このセクションは、Unity が Unity 2021.2 より古いプレイヤーを実行しているデバイスを検出した場合にのみ表示されます。 これらのプレイヤーには、Product Name、IP、または Port 情報がありません。
Direct Connection	このオプションを使うと、特定の IP とポートの組み合わせに接続できます。このカテゴリには、直近に接続した IP が表示されます。

プラットフォーム別のプロファイリングの手引き

プラットフォームを Unity Profiler に接続したときの動作は、プラットフォームごとに異なります。以下のセクションでは、各プラットフォームに共通する動作について説明します。

Web

You can use the Unity Profiler in the Web platform, but you cannot attach to a running player built with Web via the Editor. This is because the WebGL API uses WebSockets for communication, which does not allow incoming connections on the browser side. To attach to a running player, you need to enable the Autoconnect Profiler checkbox in Build Settings (menu: File > Build Settings). Unity cannot profile draw calls for Web applications.

モバイルデバイスでのプロファイリング

iOS デバイスと Android デバイスはどちらも、ネットワークを通じてリモートプロファイリングをサポートしています。ファイアウォールを使用している場合は、ファイアウォールの設定でポート番号 54998 から 55511 が開放されていることを確認します。これらは、Unity がリモートプロファイリングに使用するポートです。

When you set up remote profiling, the Unity Editor might sometimes not connect to the device automatically. If this happens, you can initiate the Profiler connection manually by selecting the Attach to Player dropdown menu in the Profiler window and choosing the appropriate device.

ターゲットデバイスを直接コンピューターに接続して、ネットワークや接続の問題を回避することもできます。

iOS remote profiling

iOS デバイスでリモートプロファイリングを有効にするには、以下の手順を実行します。

1. iOS デバイスを Wi-Fi ネットワークに接続します。プロファイラーはローカル Wi-Fi ネットワークを使用して、デバイスから Unity エディターにプロファイリングデータを送信します。
2. Attach your device to your computer via cable. In the Build Settings window (menu: File > Build Settings), select the Development Build and Autoconnect Profiler checkboxes, then click Build & Run.
3. When the application launches on the device, open the Profiler window in the Unity Editor (menu: Window > Analysis > Profiler).

Android remote profiling

Android devices support two methods of remote profiling: WiFi and Android Debug Bridge (adb).

Wi-Fi プロファイリングは、以下の手順で行います。

1. Android デバイスの モバイルデータを無効にします。
2. Connect your Android device to your WiFi network. The Profiler uses a local WiFi network to send profiling data from your device to the Unity Editor.
3. Attach your device to your computer via cable. In the Build Settings window (menu: File > Build Settings), select the Development Build and Autoconnect Profiler checkboxes, then click Build & Run.
4. When the application launches on the device, open the Profiler window in the Unity Editor (menu: Window > Analysis > Profiler).

ノート: デバイスの検出が正常に機能するためには、Android デバイスとホストコンピューター (Unity エディターを実行中) は、両方とも同じサブネット上になければなりません。

Android Debug Bridge (adb) プロファイリングは、以下の手順で行います。

1. デバイスが Development mode (開発モード) であることを確認し、USB debugging (USB デバッグ) の設定を有効にします。
2. ケーブルでデバイスをコンピューターに接続し、adb devices リストに表示されていることを確認します。
3. In the Build Settings window (menu: File > Build Settings), select the Development Build checkbox, and then click Build & Run.
4. アプリケーションがデバイスで起動したら、Unity エディターで Profiler ウィンドウを開きます (Window > Analysis > Profiler)。
5. From the Attach to Player dropdown menu, select AndroidProfiler(ADB@127.0.0.1:34999). The entry in the dropdown menu is only visible when the selected target is Android.

Build & Run を選択すると、Unity エディターはアプリケーションのために自動的に adb トンネルを作成します。別のアプリケーションをプロファイルしたい場合や adb サーバーを再起動した場合は、このトンネルを手動で設定する必要があります。これを行うためには、ターミナル/コマンドウィンドウを開き、以下のコマンドを入力します。

• エディターからアンドロイドへ USB ケーブルで接続している場合

  adb forward tcp:34999 localabstract:Unity-{insert bundle identifier here}

• Android からエディターへ USB ケーブルで接続している場合

  adb reverse tcp:34998 tcp:34999

Android ビルドでディーププロファイリングを使用するには、Android Player Settings (Edit > Project Settings > Player > Android > Other Settings) で Mono Scripting Backend 設定を有効にし、以下を入力して adb コマンドでゲームを開始します。

~$ adb shell am start -n {ここにバンドルの識別子を入れる}/com.unity3d.player.UnityPlayerActivity -e 'unity' '-deepprofiling'

ChromeOS remote profiling

ChromeOS devices support remote profiling through adb over WiFi, unlike Android devices that support remote profiling through both WiFi and adb over USB connection.

To enable WiFi profiling on ChromeOS devices, follow these steps:

1. Enable Linux Development Environment and ADB debugging settings on your Chromebook. You need not enable ChromeOS Developer Mode. For more information on how to do this, refer to Enable ADB Debug.
2. Connect your Chromebook and the host computer running Unity Editor to the same WiFi network.
3. Establish a connection between your Chromebook and the host computer through adb. For more information on how to do this, refer to Connect to ADB over a network.
4. In the Build Settings window (menu: File > Build Settings), select the Development Build and Autoconnect Profiler checkboxes, and then click Build & Run.
5. When the application launches on the device, open the Profiler window in the Unity Editor (menu: Window > Analysis > Profiler).
   Note: If your application is not deploying to the Chromebook, check the Run Device dropdown in the Build Settings. If your device isn’t listed, but the adb connection between the host computer and Chromebook is established, enter the IP address of the device through the <Enter IP> option in the Run Device dropdown. After you enter the IP address, you can profile your application as usual.

Unity エディターのプロファイリング

Profiler ウィンドウを使用してエディターでアプリケーションの実行とプロファイリングを行う場合、結果は、ターゲットプラットフォームで実行したときのアプリケーションの動作の近似にすぎません。これは、再生モードはエディターと同じプロセスで実行されるため、アプリケーションの CPU、GPU、メモリ使用を Unity から完全に分離することができないからです。これにより、結果のプロファイリングデータがさらに歪められます。

より適切なプロファイル結果を得るには、常にターゲットデバイス上でアプリケーションをプロファイルし、エディターでのプロファイリングは、すでにデバイス上で特定された問題を素早く繰り返す目的でのみ行ってください。

また、再生モードでプロファイルしたりエディターをプロファイルして、アプリケーションのパフォーマンスとは関係のない問題 (ロード時間が長くなったり、エディターが反応しなかったりしてイテレーション時間が遅くなっていないかなど、プレイモードでのアプリケーションのパフォーマンスが悪くなっていないかなど) を特定することができます。

エディターでプロファイリングを行う際には、プレイモードを最大サイズで開き、エディターウィンドウの数を減らすようにしてください。これにより、他のエディターウィンドウがレンダリングスレッドや GPU の時間を消費しないため、パフォーマンスデータに影響を与えることがなくなります。プレイモードが最大サイズで表示されていると、ターゲットデバイスの解像度に近い状態でアプリケーションを実行するため、フィルレートに関連する問題のようなパフォーマンス問題に直接影響します。

再生モードでのプロファイリング

プロファイラーのデフォルトのターゲットは再生モードで、エディターが再生モードを実行しているときのアクティビティを記録します。再生モードでのプロファイリングは、プレイヤーをリビルドすることなく迅速な変更をテストするのに便利ですが、アプリケーションのターゲットプラットフォームやデバイス上でのビルドを検証する代わりに使用すべきではありません。これは、再生モードがエディターと同じアプリケーションとメインスレッドで実行されているため、再生モードでプロファイルすると、UI、インスペクター、シーンビューレンダリング、アセット管理などのエディターのシステムが、アプリケーションのパフォーマンスとメモリーのプロファイリングの測定値に影響を与えるからです。

再生モードで効果的にプロファイリングを行うためには、定期的にアプリケーションのビルドを作成し、さまざまなターゲットデバイス (高スペックのデバイスと低スペックのデバイスの両方) にデプロイし、これらのデバイス上でアプリケーションのテストとプロファイリングを行う必要があります。これらのデバイスでアプリケーションのパフォーマンス問題が確認されたら、問題の領域を絞り込みます。

その後、再生モードでアプリケーションをプロファイルし、アプリケーションに変更を加えたら、素早くプロファイリングを繰り返します。ターゲットデバイス上のアプリケーションをプロファイルして得た情報を利用して、再生モードでプロファイルした後に同様の動作があるかどうかを確認できます。その後、アプリケーションに変更を加え、再生モードで再度プロファイルすれば、変更による効果をすぐに確認することができます。変更結果に満足したら、アプリケーションをビルドしてターゲットデバイスに再度デプロイし、変更内容を検証します。

PlayerLoop と EditorLoop のサンプル

再生モード中にエディターが作成するプロファイリングデータのノイズや誤解を招く測定値を減らすために、CPU と GPU のプロファイラーモジュールは、そのタイミングを PlayerLoop で発生するものと EditorLoop で発生するものに分けています。Unity は、これらのタイプのプロファイラーサンプルに PlayerLoop と EditorLoop のマーカー を割り当てます。

プロファイラーが再生モードをターゲットにする場合、PlayerLoop 内で発生したタイミングサンプルのみを収集します。

Unity は、CPU Profiler モジュールチャート で、EditorLoop のサンプルを Others として分類します。その結果、EditorLoop のサンプルがそのカテゴリ内で最大の割合を占めています。もし、この時間のエディターのアクションや、Others カテゴリの詳細な内訳を見たい場合は、代わりに Profiler のターゲットを Editor に変更してください。

重要: Deep Profiling を使用し、再生モードをターゲットにすると、PlayerLoop と EditorLoop の両方で発生するすべての関数の呼び出しにパフォーマンス上の影響を与えます。これは、Deep Profiling がドメインの再ロード時にスクリプトのメソッド呼び出しの最初と最後にフックするためで、どの部分が PlayerLoop から呼び出されないかを検出しないからです。EditorLoop で発生するメソッドの呼び出しは、サンプル作成のオーバーヘッドを完全には発生させませんが、サンプルを発行すべきかどうかをチェックするため、小さいながらもオーバーヘッドを発生させます。

エディターのプロファイリング

Profiler のターゲットを Editor に変更すると、以前は EditorLoop マーカーの下に隠れていたすべてのサンプルが、それぞれのカテゴリに表示されます。これは、CPU Profiler モジュールの詳細ペインとチャートの情報が大きく変わることを意味します。

エディターの起動時間をプロファイルするには、コマンドラインオプション -profiler-enable でエディターを起動します。

Profiler ウィンドウがエディターのパフォーマンスに与える影響を軽減するために、Profiler ウィンドウを独自のプロセスで開く スタンドアロンプロファイラー を使用することができます。これは、プロファイリングの対象としてエディターを選択する場合や、アプリケーションのディーププロファイリング を行う場合に特に便利です。なぜなら、通常、Profiler ウィンドウ自体が、パフォーマンスデータを歪める可能性のあるリソースを使用しているからです。

アプリケーションをプロファイルするためのベストプラクティス

When you profile your application, there are a few things that you can do to ensure consistency across profiling sessions, and to make sure that the processes that Unity uses do not affect your profiling data:

• Only add the Profiler modules related to the area that you want to investigate to the Profiler window. To add and remove modules to the Profiler, select the dropdown in the top left of the Profiler window.
• Avoid using Deep Profiling, because it might create a high overhead when you use it. If you want to see more details on samples with markers such as GC.Alloc or JobFence.Complete, go to the Profiler window toolbar and enable the Call Stacks setting. This provides the sample’s full call stack, which gives you the information you need without incurring the overhead of Deep Profiling.
• Disable the Live setting, if you do not need to see the Hierarchy or Timeline view updating as the Profiler collects data. To see the data update in the window, you can stop recording.
• F9 のショートカットを使って、Profiler を有効/無効にできます。このショートカットを使用すると、Profiler ウィンドウを開くことなくパフォーマンスデータをキャプチャできます。スタンドアロンプロファイラーを開いている場合、このショートカットを使用すると、このウィンドウでレコーディングが開始されます。

---

• ディーププロファイリングのサポートは 2019.3 で追加NewIn20193