クラッシュと例外のレポートの設定

プロジェクトでクラッシュと例外のレポートを設定する前に、使用の準備ガイド に記載されている基本的な設定の要件に従っていることを確認してください。プロジェクトを Unity Dashboard に接続するためのプロジェクト ID があることが重要です。ダッシュボードで基本的なプロジェクト認証情報を設定したら、Unity エディターでプロジェクトに対してクラッシュと例外のレポートを有効にできます。

クラッシュと例外のレポートを有効にするには、以下を行います。

  1. Unity エディターでプロジェクトを開きます。
  2. Unity エディターのメニューから、Window (ウィンドウ) > General (全般) > Services (サービス) を選択して Services (サービス) ウィンドウを開きます。
  3. Services (サービス) ウィンドウから、Cloud Diagnostics を選択します。
  4. Crash and Exception Reporting (クラッシュと例外のレポート) の横にあるトグルを選択して、サービスを有効にします。

Advanced Cloud Diagnostics でのカスタマイズしたレポートの設定

デフォルトでは、クラッシュと例外のレポートは、デバイス OS などの標準メタデータで設定されます。Advanced Cloud Diagnostics では、さらにデバッグ能力を高めるためにカスタムメタデータを追加することもできます。このカスタムメタデータは、ゲームが最初に初期化されたとき、新しいレベルがロードされたとき、プレイヤーが特定のアクションを実行したときなど、任意の時点でキャプチャできます。

クラッシュと例外のレポートには、クラッシュレポートとカスタムメタデータを設定するための CrashReportHandler クラスが含まれています。SetUserMetadata メソッドを使用して、最大 64 個のカスタムメタデータエントリーをレポートに追加します。

以下のステートメントを使用して、追跡する新しいメタデータをリクエストします。

UnityEngine.CrashReportHandler.CrashReportHandler.SetUserMetadata(“key”, “value”);

テストレポートのトリガー

レポートをトリガーして Unity Dashboard で表示することで、Cloud Diagnostics サービスをテストします。例外をスローするか、Debug.LogException() メソッドを使用して例外メッセージをログに記録して、レポートを作成します。これを行うには、C# スクリプト内でテスト例外を発生させたいメソッド (最初の画面がロードされたときに実行されるメソッドなど) を見つけ、以下の行を追加します。

Debug.LogException(new Exception(“Testing Cloud Diagnostics reports”));

スクリプトを保存し、再生モードでゲームを実行します。エディター内のコンソールに Debug.LogException メッセージが表示されるはずです。

テストレポートの表示

Unity Dashboard から以下のように Cloud Diagnostics レポートを表示します。

  1. Unity Dashboard を開きます。
  2. 上部のナビゲーションメニューのプロジェクトセレクターから、Cloud Diagnostics が有効になっているプロジェクトを選択します。
  3. メインナビゲーションメニューから、Suites (スイート) > DevOps > Cloud Diagnostics > Crash and Exception Reporting (クラッシュと例外のレポート) に移動します。
  4. Problems (問題) セクションにテストレポートが表示されます。テストレポートのタイトルを選択して、そのデータを表示します。

新しいレポートの通知の設定

Cloud Diagnostics ではインテグレーションによるレポート通知がサポートされているため、開発ワークフローを Unity 以外のツールに接続できます。ダッシュボードを手動でチェックして新しい問題がレポートされているかどうかを確認する代わりに、E メール、Slack、Discord、Trello などのサードパーティとのインテグレーションによる通知を受信できます。

レポート通知を設定するには、以下を行います。

  1. Unity Dashboard を開きます。

  2. 上部のナビゲーションメニューのプロジェクトセレクターから、プロジェクトを選択します。

    • ノート: レポート通知を設定する前に、このプロジェクトでクラッシュと例外のレポートが有効になっていることを確認してください。
  3. メインナビゲーションメニューから、Projects (プロジェクト) を選択します。

  4. 展開されたドロップダウンリストから、Project settings (プロジェクト設定) > Integrations (インテグレーション) を選択します。

  5. New Integration (新しいインテグレーション) ボタンを選択し、ポップアップモーダルの指示に従います。

バッチモードのサポート

2018.4.1+ および 2019.1.3+ では、Unity を -batchmode で実行する場合にネイティブクラッシュレポートがサポートされるようになりました。ネイティブクラッシュレポートは、アプリケーションを サーバービルド として実行する場合にもサポートされます。バッチモードで実行する場合には、USYM_UPLOAD_AUTH_TOKEN エラーが発生しないように、コマンドラインで -username と -password の両方を必ず指定してください。

次のステップ

クラッシュと例外のレポートを有効にしたので、次は それらを理解して管理する 方法を学びましょう。