Documentation

Cloud Diagnostics

Cloud Diagnostics

Set up User Reporting

Integrate the User Reporting SDK with your app to enable player feedback collection.
Read time 2 minutesLast updated a day ago
Important
Cloud Diagnostics is deprecated, and will be phased out in future versions of Unity. For more robust reports and device information, including information on Application Not Responding (ANR) errors for Android, use the diagnostics experience available in Unity 6.2 and later. For information about migrating from Cloud Diagnostics, refer to Migrate to Diagnostics in the Unity Dashboard.
Integrate the User Reporting SDK with your app to set up user reports. Once integrated, you can use the built-in user report prefab, or create your own custom user reports without the prefab.
Note
Before you integrate User reports with your project, make sure you set up your project for Unity Services. Your project must be in the Editor to the Dashboard with a project ID. See Setting up your project for Unity Services.
To add the built-in example User Reporting Prefab to your project:
  1. Open the Package Manager in the Editor, then locate the User Reporting package and select the Samples tab.
  2. Locate the User Reporting Example, and select Import.
  3. In your project, add the User Reporting Prefab to the desired scene.
  4. In your Assets folder, open Samples and select the User Reporting folder.
  5. Open the folder titled with the package version you installed (for example, 1.0.0).
  6. Open the User Reporting Example folder.
  7. Drag and drop the UserReportFormExample prefab into your scene.

Set up notifications for new reports

User Reporting supports new report notifications via Integrations so you can connect your development workflow to non-Unity tools. Receive a notification via third-party integrations such as email, Slack, Discord, Trello, and more. To set up notifications:
  1. In the Unity Dashboard, select Home > Projects.
  2. Select your project.
    Note
    Make sure you’ve added and enabled User Reporting for the project before setting up report notifications.
  3. In the primary navigation menu, select Development > Settings.
  4. In the Project Integrations section, select New Integration.
  5. Select the type of integration you want to add.
  6. Enter the connection details and settings for your chosen integration service.
  7. Depending on your integration, select Create or Connect.

Test reports and notifications

The sample scene is an effective tool for confirming whether or not your User Reporting has been set up correctly. In this example, we’ll optionally include a test of the email notification integration for new reports. To set up email notifications (optional):
  1. In the Unity Dashboard, select Home > Projects.
  2. Select your project. Note: Make sure you’ve added and enabled User Reporting for the project before setting up report notifications.
  3. In the primary navigation menu, select Development > Settings.
  4. In the Project Integrations section, select New Integration.
  5. Select the type of integration you want to add.
  6. Enter the connection details and settings for your chosen integration service.
  7. Depending on your integration, select Create or Connect.
  8. Enable the Report Received event option.
To test that reports are received:
  1. Open your Unity project.
  2. In your Assets folder, open Samples and select User Reporting.
  3. Locate the UserReportingExample.unity scene in the User Reporting Example folder.
  4. Start the scene. Click anywhere to spawn a cube in the scene, the select Create Report to open the submission form.
  5. Fill out the form and select Submit, and check the report is sent successfully.
  6. In the Unity Dashboard, go to Development > Products.
  7. Select Cloud Diagnostics.
  8. Select User Reporting.
Your report appears on the Dashboard after a few minutes. If you set up an optional integration, then the notification arrives around the same time as the report appears.