Logging & Feedback

Introduction

User eXperience kit helps you gather rich game data in a well formatted log, and then feed that data from within your game tools such as Trello, Zendesk, Unity's User Reporting, etc. and to help you capture and save screenshots for the full screen or sections of the screen.

Features

Advanced Log

A log system which stores all Debug.Log messages with optional stack trace information, and additional system information generated at run time. The log can be reported as a simple text log or serialized to a JSON object for easier programmatic processing.

Trello Integration

You can use the Trello integration to interact with Trello such as to create cards and upload attachments. Terllo is most useful for production feedback such as gathering feedback from closed testers and QC staff.

It is possible release with Trello integration but not advised as you risk exposing your Trello API Key and token.

Unity User Reporting

Did you know Unity cloud services includes a flexible and easy to use User Reporting service? This service is well suited to gathering end user feedback and bug reports and can be easyily integrated with the Advanced Log and Screenshot interfaces.

User Reporting | Unity Cloud Diagnostics

Easy 3rd Party Extension

The system is designed to be easily integrated with the reporting tools of your choice. The log produced can be exported as simple text or as a JSON object for easy parsing by other tools, and includes an easy to use Screenshot tool capable of capturing a full screen or any defined rect of a screen, and returning that data as a Texture2D or quickly saving it out as a Jpg or Png.

3rd Party Support Tools

You can use the Feedback system with 3rd party support tools such as Zendesk to better inform your support team.

Lets assume you are using Zendesk as your support tool provider and you have integrated Zendesk with your game for a direct user support experience. In the case of support requests Zendesk allows you to define custom fields and these fields can be made invisible to the Support Request form which makes since for system data that isn't meant to be edited by a user but is useful for the support agent to know

Support requests

For this example lets assume you have created custom fields in Zendesk as such

You can now record the system data gathered by the custom log

Dictionary<long,string> invisibleCustomFields = new Dictionary<long,string>;
var logObject = API.Log.Object;
invisibleCustomFields.Add(1, logObject.companyName);
invisibleCustomFields.Add(2, logObject.productName);
invisibleCustomFields.Add(3, logObject.productVersion);
invisibleCustomFields.Add(4, logObject.engineVersion);
invisibleCustomFields.Add(5, logObject.commandLine);
invisibleCustomFields.Add(6, logObject.platform);
invisibleCustomFields.Add(7, logObject.deviceType);
invisibleCustomFields.Add(8, logObject.deviceModel);
invisibleCustomFields.Add(9, logObject.deviceName);
invisibleCustomFields.Add(10, logObject.os);
invisibleCustomFields.Add(11, logObject.osFamily);
invisibleCustomFields.Add(12, logObject.cpuType);
invisibleCustomFields.Add(13, logObject.cpuCount);
invisibleCustomFields.Add(14, logObject.cpuFrequency);
invisibleCustomFields.Add(15, logObject.systemMemory);
invisibleCustomFields.Add(16, logObject.gpuVendor);
invisibleCustomFields.Add(17, logObject.gpuType);
invisibleCustomFields.Add(18, logObject.gpuName);
invisibleCustomFields.Add(19, logObject.gpuVersion);
invisibleCustomFields.Add(20, logObject.gpuMemory);
invisibleCustomFields.Add(21, logObject.gpuShaderLevel);

zendeskSupportUI.SetInvisibleCustomFields(invisibleCustomFields);