Unreal Engine の Unreal Insights セッションブラウザ | Unreal Engine 5.7 ドキュメンテーション

Unreal Insights を起動すると、[Session Browser (セッションブラウザ)] ウィンドウが開きます。このウィンドウで表示したいトレースセッションを選択できます。このページでは、トレースを読み込み、ライブトレースセッションに接続するためにセッションブラウザを使用する方法に関する [Session Browser] ウィンドウのリファレンスを提示します。

Unreal Insights のワークフローの概要については、「Unreal Insights の概要」を参照してください。

Trace Store タブ

[Trace Store (トレースストア)] タブ は表示可能なトレースセッションファイルのリストを提示します。これには、ローカルマシンのファイルおよびリモートトレースレコーダーサーバーで利用可能なファイルを含みます。各セッションはアプリケーションのパフォーマンスとリソース使用についての記録データを含みます

Session browser UI features labeled with numbers corresponding to the table below.

要素	名称	説明
1	ストア設定を管理する	ドロップダウンをクリックし、トレースストアディレクトリ (4) と追加のディレクトリ (5) を表示します。
2	ストアホスト	トレースサーバーの IP アドレス。デフォルトでは、127.0.0.1 に設定されています。つまり、ローカルトレースサーバーを使用します。リモートトレースサーバーがある場合、その IP アドレスを指定して、代わりにそこでトレースデータを検索できます。正常に接続すると、緑のチェックマークのアイコンが表示され、接続に失敗すると警告アイコンが表示されます。このフィールドを強調表示すると、追加のトレースサーバー情報 (バージョンとポート) がツールチップに表示されます。
3	ディレクトリ	トレースサーバーが新しいトレースを保存するディレクトリです。
4	トレースストアディレクトリ	トレースストアディレクトリ (3) の別の表示です。このオプションは通常、非表示です。折りたたみをクリックして表示します。
5	追加のディレクトリ	Unreal Trace サーバーがトレースファイルを監視する他のディレクトリです。トレースストアディレクトリと監視されている外部のディレクトリの両方のトレースファイルが、[Trace Store] タブのセッションリストの統合リストに表示されます。このオプションは通常、非表示です。折りたたみをクリックして表示します。
6	名前/コマンドラインの切り替え	名前フィルタを使用する場合、名前とコマンドラインのフィルタリングを切り替えます。
7	名前フィルタ	切り替えたモードによってトレースセッションを名前またはコマンドラインでフィルタリングします (6)。トレースセッション名は数字の文字列で表されていますが、このフィルタを使用して検索したいセッションの範囲を絞り込めます。
8	フィルタバー	トレースセッションリストの列のフィルタ (9)。詳細については、下の「フィルタ」セクションを参照してください。
9	トレースセッションリスト	選択したディレクトリのプロファイル可能なトレースセッションのリストです (3/4)。同時に複数のトレースファイルを選択できます。
10	解析の自動スタートの切り替え	ライブトレースセッションの解析の自動スタートを有効または無効にします。この設定はセッション間で保持されます。
11	自動スタートフィルタ	自動スタートが特定の場合のみに行われるよう制限します。プラットフォームまたはアプリ名でフィルタリングできます。
12	自動接続 (Windows のみ)	有効な場合、UE アプリケーションは、ローカルトレースサーバーと自動接続し、Unreal Insights が実行中の場合はトレースを開始します。
13	[Open Trace (トレースを開く)] ボタン	[Open Trace] ボタンをクリックして、トレースセッションリストで選択したセッションの Unreal Insights を開きます (9)。
14	[Open Trace (トレースを開く)] ドロップダウン	[Open Trace] ボタンの横のドロップダウンは、トレースを開く他のメソッドを表示します。詳細については、下の「[Open Trace] ドロップダウン」セクションを参照してください。

フィルタ

フィルタバーは、トレースセッションリストの列に対応するフィルタのドロップダウンを含みます。各ドロップダウンをクリックすると、フィルタリングしたい値を切り替えられます。以下は、利用可能なフィルタのタイプです。

フィルタ	説明
プラットフォーム	プロファイルしたいビルドのターゲットプラットフォームでフィルタリングします。たとえば、Win64、Mac、または Linux。
アプリ名	プロファイルしたいアプリケーションの名前でフィルタリングします。これは、どのアプリに属しているかに関係なく、個別のセッションの識別子であるトレースセッション名とは異なります。
コンフィギュレーション	ビルドコンフィギュレーションでフィルタリングします。たとえば、デバッグ、開発、シッピングのタイプのビルドコンフィギュレーションでフィルタリングできます。
ターゲット	ビルドターゲットでフィルタリングします。たとえば、エディタ、ゲーム、クライアント、またはサーバービルドターゲットでフィルタリングできます。
ブランチ	アプリケーションに関連付けられているバージョン管理システムのブランチでフィルタリングできます。
サイズ	トレースファイルのサイズに基づいてフィルタリングします。
ステータス	セッションがオフラインかライブかに基づいてフィルタリングします。

解析のためにトレースを読み込む

解析用にトレースを読み込むには、以下のオプションがあります。

Unreal Insights ブラウザに表示されたいずれかのトレースセッションをダブルクリックする。
トレースセッションを選択して、[Open Trace] をクリックする。
Windows を使用している場合、エクスプローラーから Unreal Insights] ウィンドウ .utrace ファイルをドロップ＆ドラッグし、トレースファイルの解析を開始する。
[Open Trace] ドロップダウン を使用して、他の場所で .utrace ファイルを検索する。

トレースセッションを開くと、Unreal Insights は、Insights のメインプロファイリングツールを備える Timing Insights を開きます。

[Open Trace (トレースを開く)] ドロップダウン

[Open Trace] ボタンの横のドロップダウンは、トレースを開くための詳細なオプションを表示します。

オプション	説明
Misc
ファイルを開く	手動でトレースファイルを選択するためファイルブラウザを開きます。
テーブルをインポート	テーブルビューに CSV または TSV をインポートします。
テーブルの差分...	2 つのテーブルを差分モードで開きます。
最近作成されたトレース上位
トレースエントリ	すぐにアクセスできるリストに最近作成されたトレースを表示します。
サーバー
Unreal Trace サーバー	ローカルトレースサーバーのサブメニューを表示します。詳細については、下の「Unreal Trace サーバー」セクションを参照してください。
デバッグオプション
セッション自動化テストを有効化	このウィンドウから開いたセッションの自動化テストシステムを有効にします。
デバッグツールを有効化	このウィンドウから開いたセッションのデバッグツールを有効にします。
Starship テストスイート	さまざまな UI のプレビューを含む、Starship UX テストスイートを開きます。

Unreal Trace サーバーの折りたたみ

[Open Trace] ドロップダウンの Unreal Trace サーバーオプションは、情報付きサブメニューを表示しトレースサーバーインスタンスを制御します。以下のオプションを使用できます。

オプション	説明
スポンサーモード	有効な場合、サーバーを利用しているローカルプロセスが実行中である限りにおいてのみサーバーが動作します。
開始	まだ動作していない場合、ローカルトレースサーバーを開始します。
停止	もう動作している場合、ローカルトレースサーバーを停止します。

上記のオプションに加え、このサブメニューは以下の項目を表示します。

バージョン番号。
サーバーのレコーダーポート。
サーバーのストアポート。

ライブ接続

ライブステータスは、トレースセッションが現在レコーディング中であることを表します。ライブトレースセッションが Unreal Trace サーバーに接続する場合は、それがトレースストアリストにも表示されます。ライブセッションのステータス列には「LIVE」と表示され、解析中にリアルタイムで更新されます。それ以外の点では、事前に記録されたセッションと同じです。

ツールは複数のセッションを同時に監視することができ、データの受信に伴ってすべてのセッションのデータを自動的に記録します。これらのセッションは、(事前に記録されたセッションと同じ方法で) リストからロードすることでリアルタイムに分析できます。

The Trace Store tab showing a LIVE session

コンテキストメニュー

トレースストアリストのエントリを右クリックすると、そのトレースで使用できるアクションを含むコンテキストメニューが表示されます。

オプション	説明
トレース ID をコピー	クリップボードにトレースセッションファイルのトレース ID をコピーします。
フルパスをコピー	トレースセッションファイルが保存されているファイルパスをコピーします。
含むフォルダを開く	トレースセッションファイルを含むフォルダを開きます。
名前を変更	トレースファイルの新しい名前を入力します。
削除	選択したトレースファイルを削除します。複数のトレースを選択する場合、そのすべてを削除するためにこのオプションを使用できます。

[Connection (接続)] タブ

[Connection] タブ は、実行中のゲームまたはトレースサーバーを使用中のエディタに接続するためのインターフェースを提供します。このタブは、接続設定を変更するための複数のオプションを備えています。

パラメータ	説明
トレースレコーダー IP アドレス	トレースサーバーの IP アドレス。
実行中のインスタンス IP アドレス初期チャンネル	トレースサーバーに接続してデータのトレースを開始するプロジェクト (実行中のインスタンス) の IP アドレス。
初期チャンネル	トレース接続がデータの解析を開始するときに有効にするトレースチャンネルのリストを指定するフィールド。

トレースレコーダーを接続するには、上記の各フィールドに入力し、[Connect] をクリックします。新しい接続に対応する新しいライブセッションは、トレースセッションリストに表示され、LIVE とマークされます。ローカルトレースデータに加え、リモートトレースデータもトレースストアで利用可能になりました。