Getting Started with Cloud Diagnostics

Unity Cloud Diagnostics is a service that collects and reports data about errors (known as crashes or exceptions) in your game. Cloud Diagnostics can also be used to collect player feedback, such as bug reports or feature requests. Cloud Diagnostics connects to your project in the Unity Editor and can be managed from the Unity Dashboard.

The insights from Cloud Diagnostics help you to better diagnose any problems in your game so you can provide a better gameplay experience. Cloud Diagnostics is recommended for both the game development testing cycle and when your app is live.

The following article provides an overview of:

 

Unity plans and Cloud Diagnostics tiers

Cloud Diagnostics is a service automatically bundled with your Unity plan, whether you use Unity Personal, Pro, or Plus. Note that while Cloud Diagnostics is available across all Unity plans, feature capacity differs across Unity subscription types. Here’s a breakdown of what’s included with Cloud Diagnostics depending on your Unity plan:

Unity plan Cloud Diagnostics tier
Unity Personal: Unity license free to individual users and includes basic access to products and features. Unity Personal includes access to Cloud Diagnostics.

Cloud Diagnostics:

  • 25 Crash & Exception reports/day

  • 10 user-generated reports/day

  • 10 MB user-generated reports storage /day

  • 7 days data retention

Unity Pro: Unity license providing small studios with more functionality and resources than the Unity Personal plan. Unity Pro includes access to Advanced Cloud Diagnostics.

Advanced Cloud Diagnostics:

  • 10,000 Crash & Exception reports/day

  • 1,000 user-generated reports/day

  • 1 GB user-generated reports storage /day

  • 90 days data retention Detailed crash and exception logs Custom crash and exception metadata

Unity Plus: Unity license providing professional developers with a complete solution to create and operate their game. Unity Plus includes access to Advanced Cloud Diagnostics.

To select a subscription or change your Unity plan, go to the Unity Store.

 

Basic setup requirements

While Cloud Diagnostics is automatically bundled in your Unity plan, there are a few basic requirements you’ll need before setting up Cloud Diagnostics in your project.

To integrate with the Cloud Diagnostics service, you’ll need:

  • A Unity ID and organization to log in to the Editor or Dashboard and manage your projects.
  • A project in the Unity Editor to provide data and content for connected services.
  • A project ID to connect your project in the Editor with services in the Dashboard.
  • A supported OS platform. Cloud Diagnostics currently supports iOS, Android, macOS, and Windows Desktop.

Key concepts explained

Unity plan: The basic subscription type you’re using with Unity, whether Unity Personal, Pro, Plus or Enterprise. A Unity subscription determines your usage and feature access for the Unity Editor and some Unity Dashboard services.

Unity ID and organization: A Unity ID is used to log in to the Unity Dashboard and an organization is a profile for managing your game development projects, teams, and services on the Dashboard.

Project: A game built in the Unity Editor.

Project ID: A unique identifier for your Unity project that enables use of any Unity Service on the Unity Dashboard for that project.

It’s helpful to view the Unity Editor as where you create your project, and the Unity Dashboard as where you manage your project, organization and its associated services.

 

Basic setup of Cloud Diagnostics

To set up Cloud Diagnostics, ensure you have the basic requirements outlined in the section above. Note that you cannot activate Cloud Diagnostics without a project ID linking the service to your project.

To set up Crash and Exception Reporting, go to your project in the Unity Editor and go to Window > General > Services > Cloud Diagnostics. From the Cloud Diagnostics modal, toggle on Crashes and Exceptions. You can manage crash and exception reports and upload debugging symbols from the Unity Dashboard > Cloud Diagnostics page. For more information on setting up Crash and Exception Reporting, go to Setting up Crash and Exception Reporting.

To set up User Reporting, you’ll need to download the User Reporting SDK and integrate the SDK within your project on the Unity Editor. Once integrated, you can manage user report insights from the Unity Dashboard > Cloud Diagnostics page. For more information on setting up User Reporting, go toSetting up User Reporting.