Unreal EngineにBacktraceを導入してクラッシュレポートを管理！簡単にクラッシュできるおまけつき！

Calendar for Unreal Engine (UE) | Advent Calendar 2021 - Qiita

パート3の14日目です！

昨日はminami_kohさんの「[UE4] 具体的な実装例から知るマルチプレイヤーゲーム実装の基本のキ - Qiita」でした。

本日はどうぞよろしくおねがいいたします。

記事の目的・概要
- Backtraceとは
- Backtrace GameJamとは
  - 作ったゲーム
覚えておくとよい用語
Backtrace側設定
Unreal Engineプロジェクト側設定
パッケージングのfix
- エンジン側のプラグイン場所特定
- プロジェクトをビルド
クラッシュさせる
クラッシュレポートを送信し、管理画面で確認してみる
- ゲームのクラッシュ
- トリアージ画面を確認
おまけ
おわりに

記事の目的・概要

Backtrace GameJam に参加しました。次回のBacktrace GameJam開催時には参加してくれる人が増えたらいいなと思いましたので、読んだ人がスムーズにBacktrace設定でき、一瞬でゲームクラッシュさせ、クラッシュレポートを上げられるようにします。

記事の主な対象の方としては、ゲームジャムに興味のある方、できればUnreal Engine 用に Visual Studio をセットアップするなどを行いパッケージングやC++コードのビルドができる状態であると理解しやすいと思います。

Unreal Engineのバージョンは4.27.2を使用します。

流れはこんな感じです。

BacktraceをUnreal Engineに導入
プロジェクト設定のフローを説明
クラッシュさせて、web管理画面を眺めてみます

Backtraceとは

クラッシュ・例外などを収集して管理できるツールです。

マルチプラットフォーム対応。

公式サイト：https://backtrace.io/
価格(Freeプランもあり)：https://backtrace.io/pricing
プラットフォーム：https://backtrace.io/product

Backtrace GameJamとは

「期間内にBacktraceを導入してクラッシュレポートを上げること」という条件付きの変わったゲームジャムです。

ゲームジャムが何かという方はおググりください→ゲームジャム - Wikipedia

第3回が12/3~5の制作期間で行われ、「IT'S NOT A BUG」というBacktraceらしいテーマで開催されました。

作ったゲーム

少女からは見えない幽霊(テーマ回収)を操作して、明かりを消したり物を動かして驚かせ、少女がだんだんハイな気分になっていくものを作りました。

waka2ya.itch.io

itch.ioなどのゲームジャムに一緒に参加してくれる方・・・なにとぞ・・・

覚えておくとよい用語

トークンが2つあるということを覚えてください。読み飛ばしていただいてヨシ！

Subdomein(universe、REALMと書かれていることも。統一してほしい！)
- アカウントのURL。アカウント作成時に決めます。
  - https://<Subdomein>.sp.backtrace.io という管理画面となります。
Project
- プロジェクトは管理上の単位です。ゲームタイトルと同じと思ってよいかな。以下2つのトークンを複数発行して紐付かせるためのものです。
submission token（送信トークン）
- https://unreal.backtrace.io/post//<submission token>
  - という感じのURLを使ってゲームクラッシュ時に送信します。
- プロジェクトに対して複数発行でき、トークン毎に有効、無効を切り替えられます。ゲームのアップデートなどで切り替え管理するのが便利そうです。
symbol token（シンボルトークン）
- Backtraceサーバにシンボルをアップロードするための文字列で、パッケージの後半でbacktrace_post_build.exeというプログラムに対して渡すものです。
- .uprojectに書き込まれます。(Windows向けはエディタ上で設定できます。)

Backtrace側設定

アカウント・プロジェクト作成

https://backtrace.io/にアクセス
Create an accontを押してください

f:id:wakanya:20211212033849p:plain

Subdomeinが管理画面やエラー送信時のURLに使用されます。
- はずかしい文字列はやめようね
Usernameは、最初のAdmin(管理者)ユーザになります。

f:id:wakanya:20211212034020p:plain

管理者ユーザのパスワード設定です。

f:id:wakanya:20211212035028p:plain 　　 f:id:wakanya:20211212035102p:plain

サブドメインで設定した管理画面へのログイン画面となります

f:id:wakanya:20211212035141p:plain

ようこそされるので、Project名を入力します

f:id:wakanya:20211212035434p:plain 　　 f:id:wakanya:20211212035504p:plain

この画面になります。Unrealのボタンを押したいところですが、とりあえずこの記事を読み進めてください。

f:id:wakanya:20211212035704p:plain

ちなみに、左上やURLでプロジェクト名がわかります。

f:id:wakanya:20211213223321p:plain

新しく別のプロジェクトを作りたい場合は、右上のアカウントを押して、
- 「プロジェクトを作成」を選択します。

f:id:wakanya:20211212040411p:plain

送信トークンを準備

submission tokenを用意します。

設定画面に居ない場合はアカウントの部分を押して「プロジェクト設定」に移動

f:id:wakanya:20211212040813p:plain

左側から「エラー送信」を押し、送信トークンを確認します。
メモ帳かどこかにコピーしておきましょう。

f:id:wakanya:20211212040928p:plain

トークンがない場合は、右側の（+）を押して、作成します。

f:id:wakanya:20211212041121p:plain

シンボルトークンを準備

symbol tokenを用意します。

設定画面の左側より、「シンボル」 > 「アクセストークン」を選択。
トークンがなければ、右側の（+）ボタンを押して作成します。

f:id:wakanya:20211212161941p:plain

コピーしてメモ帳に控えておきましょう。

f:id:wakanya:20211212162133p:plain

Backtrace側の設定は以上になります。

Unreal Engineプロジェクト側設定

プラグイン入手とプロジェクト作成

Unreal EngineのMarketplaceよりBacktraceプラグインを入手します。

Backtrace Crash Reporting Plugin in Code Plugins - UE Marketplace

EpicGamesLauncherより、プラグインをダウンロードしてきます。エンジンにインストールしますが、後にプロジェクト側に持ってきます。

f:id:wakanya:20211212173044p:plain

プラグインをインストールしたエンジンで、新規プロジェクトを作成します。
C++プロジェクトで作成してください。(写真はUE4.27)

f:id:wakanya:20211212173300p:plain

クラッシュレポーターを含めるようにする

Edit(編集) > Project Settingsを開きます。

f:id:wakanya:20211212175420p:plain

Packaging項目のInclude Crash Reporterにチェックを入れます。これでクラッシュレポーターが含まれます。

f:id:wakanya:20211212175056p:plain

エディタ上でBacktraceプラグインを有効化し、設定を適用

エディタが起動したら、Backtraceプラグインを有効にするため、Edit > Pluginsを開きます。

f:id:wakanya:20211212173403p:plain

検索窓に「Backtrace」などと打ち、Backtraceプラグインを見つけて有効(Enabled)します。エディタの再起動を促されるので、再起動します。

f:id:wakanya:20211212173502p:plain

エディタを再起動すると、Edit > Backtraceを選択できるので選択します。

f:id:wakanya:20211212173644p:plain

↓のようなウィンドウが立ち上がります。すでにアカウントを作成しているので、「I have an account」を選択します。

f:id:wakanya:20211212173703p:plain

「Instance sub-domain」には作成したSubdomein、「Project name」も最初に作成したものを入れます。（Project nameの情報必要・・・？）

f:id:wakanya:20211212173759p:plain

次に、送信トークン（submission token）を聞かれるので、メモっておいた送信トークンを入力します。

f:id:wakanya:20211212173942p:plain

続いて、シンボルトークン（symbol token）です。送信トークンとシンボルトークンは別ですので、お間違いのないように。

f:id:wakanya:20211212174621p:plain

最後に、これでええのんか？と聞かれるのでチェックはつけずに進みます。
- もう一度Backtrace設定を開くとこの画面になるので、ここで編集できます。

f:id:wakanya:20211212175819p:plain

エディタでの設定は以上です。これでパッケージングをすればOK・・・

とはなりません。？？？？

ｽﾞｺｰ

パッケージングに失敗しますので通るように作業していきます。

パッケージングのfix

エディタ上で設定すると、プロジェクト側のPlugins以下に

Plugins\BacktraceIntegration\Source\BacktraceBlueprintLibrary\Private\BacktraceUserSettings.hというソースが生成されるのですが、

エンジン側にインストールされたプラグインにも同様のソースがあり、役割が重複しています。

なので、プロジェクト側にもってきて解決します。

（Windows以外のプラットフォームはわかりませんが、エンジン側にプラグインインストールする設定になっているの、間違いなんじゃないかな・・・）

エンジン側のプラグイン場所特定

ランチャー版エンジンの場合は、ショートカットを作ってプロパティを見てみます。

f:id:wakanya:20211212181951p:plain

作業フォルダをエクスプローラで開いてみます。

f:id:wakanya:20211212182554p:plain

UE_4.27\Engine\Plugins\Marketplaceに、「BacktraceIntegration」があるので、これを「切り取り」します。

f:id:wakanya:20211212182616p:plain

自分のプロジェクト側のPluginsにも「BacktraceIntegration」があるので、ここにペーストします。ただし、ファイルの置き換えはしないでください。プロジェクトにある方のファイルが新しいので。

f:id:wakanya:20211212182917p:plain

エンジン側に残るものが気になるなら、EpicGamesLauncherからプラグインをアンインストールしておきます。「Installed Plugins」を開きます。

f:id:wakanya:20211212183347p:plain

Backtraceを「Remove」しておきます。

f:id:wakanya:20211212183435p:plain

Plugins\Marketplace\BacktraceIntegration\Source\以下に手を入れます。
- それぞれ、末尾のPublic～をコメントアウトしてください。
BacktraceBlueprintLibrary\BacktraceBlueprintLibrary.Build.cs
// PublicIncludePathModuleNames.Add("BacktraceBlueprintLibrary");

}

}

}
BacktraceIntegration\BacktraceIntegration.Build.cs
// PublicIncludePathModuleNames.Add("BacktraceIntegration");

}

}

}
BacktraceSettingsLibrary\BacktraceSettingsLibrary.Build.cs
// PublicIncludePathModuleNames.Add("BacktraceSettingsLibrary");

}

}

}