PDBファイルの管理
注釈:本資料はAI技術を用いて翻訳されています。
Windowsでのデバッグシンボルのアップロード
クラッシュダンプからコールスタックを取得するには、AccelByte Development Toolkit (ADT)バックエンドにゲームまたはアプリケーションのデバッグシンボル情報が必要です。この情報を取得するには、Windowsでは.pdbファイルと実行可能ファイルまたは.exeファイルであるデバッグシンボルをADTバックエンドにアップロードします。
ファイルをアップロードするには、以下のタスクを順番に実行してください:
-
CrashReportClient.pakを一時フォルダに展開します。 -
一時フォルダから
CrashReportClient.iniファイルを変更します。 -
CrashReportClient.pakを再パックします。 -
.pdbファイルをシンボル用に解析してzipファイルにします。 -
.exeと.pdbファイルをshippingフォルダに単一のzipファイルとしてアーカイブします。 -
以下に示すように、
.exeと.pdbのzipファイルをADTバックエンドにアップロードします。
インライン設定なし
BlackBoxCLI.exe upload
インライン設定あり
BlackBoxCLI.exe upload --apikey asdf1234 --namespace myawesomegame --game-project D:\path\to\myawesomegame --game-engine D:\UnrealEngine\UE4.25 --game-archive D:\path\to\packaged\awesomegame --platform-name windows --platform-arch x64
ADT CLIを使用してビルドのデバッグシンボルをアップロードする
ADT CLIを使用して、エディタとパッケージ化されたビルドのデバッグシンボルをアップロードできます。両方とも同じ方法でアップロードしますが、エディタの場合は追加の--editor-build引数を使用します。
インライン設定なし
BlackBoxCLI.exe upload --editor-build
.pdbと.exeファイルをADTのバックエンドに圧縮してアップロードするのに数分かかります。アップロードが完了すると、以下の例のような結果が表示されます。
BlackBoxCLI.exe upload
Build ID: af59abac-f560-47b5-bf47-416128d8e282
Try to open Game Config File DefaultEngine.ini ("D:\\blackbox-sdk\\SampleGame\\Config\\DefaultEngine.ini")
Registering build...OK
Zipping executable and pdb ...
Compressing: AccelMania-Win64-DebugGame.exe [113965/113965] kB
Compressing: AccelMania-Win64-DebugGame.pdb [145764/145764] kB
Dump Symbol...
Compressing: AccelMania-Win64-DebugGame.sym [73980/73980] kB
Upload executable and pdb ...
Preparing to upload PDB files...
Uploading...
Sent: 71525/71525 KB
Upload Successful...
Preparing to upload Breakpad symbol...
Uploading...
Sent: 7307/7307 KB
Upload Successful...
Updating Crash Reporter Client...OK
Success!
これらのオプションを使用して、ゲームの実行可能ファイルを解析し、フィルタリングされた.pdbの内容をADTバックエンドにアップロードすることもできます。
| オプション | 含める | 除外する | 説明 |
|---|---|---|---|
-h,--help | - | - | ヘルプメッセージを表示して終了 |
-d,--dump-path | - | - | 出力JSONファイルをダンプする場所を指定します。パスを指定しない場合、システムはダンプファイルを作成しません。 |
-I,--game-build-stamp | - | --upload-only | ゲームビルドスタンプを指定 |
-u,--upload-only | --dump-path | --game-build-stamp | PDB解析フェーズをスキップして、JSONが既に存在することを前提として直接アップロードに進みます。 |
-Z,--zip-file-location | - | - | アップロード用のzipファイルへのパス。このオプションは準備されたzipファイルを期待します。 |
-E, --editor-build | エディタビルド用のPDBをアップロードします。このオプションはすべてのUnreal EditorのPDBファイルを収集し、情報をADTのバックエンドにアップロードします。 | ||
--platform-arch | アップロードするゲームデバッグシンボルのプラットフォームアーキテクチャ(例:x64) | ||
--platform-name | アップロードするゲームデバッグシンボルのプラットフォーム名(Windows、xsx、xboxonegdk、PS5など) |
Unreal 5用のLinuxデバッグシンボルのアップロード
Unreal 5用のLinuxデバッグシンボルをアップロードするには、ゲームに追加の設定が必要です。ゲームのDefaultEngine.iniファイルに以下の設定フィールドとセクションを追加してください:
[/Script/LinuxPlatform.LinuxTargetSettings]
bPreservePSYM=True
この設定ファイルを追加した後は、Linuxゲームをビルドする前に、通常intermediateディレクトリにあるビルドアーティファクトをクリーンアップしてください。クリーンアップしないとエラーが発生します。
Linuxゲームをビルドする準備ができたら、Unreal 5用のuploadコマンドを呼び出してLinuxデバッグシンボルをアップロードします:
インライン設定あり
BlackBoxCLI.exe upload --apikey asdf1234 --namespace myawesomegame --game-project D:\path\to\myawesomegame --game-engine D:\UnrealEngine\UE4.25 --game-archive D:\path\to\packaged\awesomegame --platform-name linux-server --platform-arch x64
Shippingビルド用のPDBファイル生成を有効にする
デフォルトでは、プロジェクトがShippingビルド設定に設定されている場合、Unreal EngineはPDBファイルを生成しません。これを有効にするには、Unreal Editorで以下の手順に従ってください:
-
Unreal Editorを開き、Editメニューをクリックして、ドロップダウンからProject Settingsを選択します。
-
Searchバーで「Include crash reporter」と入力し、チェックボックスをオンにして有効にします。
-
次に「Include debug files in shipping builds」を検索し、そのチェックボックスもオンにします。これによりCrash Reporter Clientが表示されるようになります。
-
エディタを閉じます。次回Shippingビルドを作成するときに、PDBファイルがパッケージ化された出力に含まれます。
LinuxビルドのPSYMシンボルの設定
Unreal Engine 5.1以上を使用している場合、<game_project>/ConfigにあるDefaultEngine.iniファイルを変更し、以下を追加する必要があります:
[/Script/LinuxPlatform.LinuxTargetSettings]
bPreservePSYM=True
この設定を有効にすると、LinuxまたはLinux-Serverビルドをパッケージ化するときに、Unrealは.debugファイルの代わりに.psymファイルを生成します。
その後、上記のUploadコマンドを使用して.psymシンボルファイルをADTにアップロードできます。これにより、ビルドでクラッシュが発生するたびに、ADTがシンボルファイルを活用して詳細なクラッシュデバッグを提供できるようになります。