Feature/metrics (#38)

* Database improvements

* Invalid meta file info

* Updated for 3.0.2

* Version update

* Store temporary json in memory

* Basic metrics implementation

* Backtrace API implementation

* Use microsends + change helper to extension method

* Replace http utility with stringBuilder to avoid compilation problems in older version of .NET scripting backend

* Changelog + readme updates

* Changelog udpate

* yield return improvement + better comment

* Report filter improvement

* better return

Co-authored-by: jasoncdavis0 <jason.davis@enterprisedb.com>

Author: konraddysput

CHANGELOG.md

@@ -23,7 +23,13 @@ Sample code:
 For example, to only get error reporting for hangs or crashes then only return false for Hang or UnhandledException or set the corresponding options in the user interface as shown below.
 
 ![Sample report filter](./Documentation~/images/report-filter.PNG)
-
+- Support for backtrace-unity timing observability. To enable sending performance information to Backtrace set the`Enable performance statistics` option in the UI. Attributes are created under the performance.* namespace, time unit is microseconds: 
+  * Report creation time (`performance.report`),
+  * JSON serialization time (`performance.json`),
+  * Database add operation time (`performance.database`),
+  * Database single send method time (`performance.send`),
+  * Database single flush method time (`performance.flush`)
+  
 
 ## Version 3.0.2
 - `BacktraceDatabase` now provides a new `Send` method. This method will try to send all objects from the database respecting the client side deduplication and retry setting. This can be used as an alternative to the `Flush` method which will try to send all objects from the database ignoring any client side deduplication and retry settings.

Editor/BacktraceConfigurationEditor.cs

@@ -63,6 +63,10 @@ public override void OnInspectorGUI()
                     serializedObject.FindProperty("NumberOfLogs"),
                     new GUIContent(BacktraceConfigurationLabels.LABEL_NUMBER_OF_LOGS));
 
+                EditorGUILayout.PropertyField(
+                 serializedObject.FindProperty("PerformanceStatistics"),
+                 new GUIContent(BacktraceConfigurationLabels.LABEL_PERFORMANCE_STATISTICS));
+
                 EditorGUILayout.PropertyField(
                     serializedObject.FindProperty("DestroyOnLoad"),
                     new GUIContent(BacktraceConfigurationLabels.LABEL_DESTROY_CLIENT_ON_SCENE_LOAD));

Editor/BacktraceConfigurationLabels.cs

@@ -15,6 +15,7 @@ internal static class BacktraceConfigurationLabels
         internal static string LABEL_IGNORE_SSL_VALIDATION = "Ignore SSL validation";
         internal static string LABEL_SEND_UNHANDLED_GAME_CRASHES_ON_STARTUP= "Send unhandled native game crashes on startup";
         internal static string LABEL_USE_NORMALIZED_EXCEPTION_MESSAGE = "Use normalized exception message";
+        internal static string LABEL_PERFORMANCE_STATISTICS = "Enable performance statistics";
 
         // database labels
         internal static string LABEL_ENABLE_DATABASE = "Enable Database";

README.md

@@ -72,6 +72,7 @@ The following is a reference guide to the Backtrace Client fields:
 - Handle unhandled exceptions: Toggle this on or off to set the library to handle unhandled exceptions that are not captured by try-catch blocks.
 - Game Object Depth Limit: Allows developer to filter number of game object childrens in Backtrace report.
 - Collect last n game logs: Collect last n number of logs generated by game. 
+- Enabled performance statistics: Allows `BacktraceClient` to measure execution time and include performance information as report attributes.
 - Ignore SSL validation: Unity by default will validate ssl certificates. By using this option you can avoid ssl certificates validation. However, if you don't need to ignore ssl validation, please set this option to false.
 - Handle ANR (Application not responding) - this options is available only in Android build. It allows to catch ANR (application not responding) events happened to your game in Android devices. In this release, ANR is set to detect after 5 seconds. This will be configurable in a future release.
 - Enable Database: When this setting is toggled, the backtrace-unity plugin will configure an offline database that will store reports if they can't be submitted do to being offline or not finding a network. When toggled on, there are a number of Database settings to configure.

Runtime/BacktraceClient.cs

@@ -155,6 +155,24 @@ public Action<BacktraceReport> OnClientReportLimitReached
 
         private INativeClient _nativeClient;
 
+        public bool EnablePerformanceStatistics
+        {
+            get
+            {
+                return Configuration.PerformanceStatistics;
+            }
+        }
+
+        public int GameObjectDepth
+        {
+            get
+            {
+                return Configuration.GameObjectDepth == 0
+                ? 16 // default maximum game object size
+                : Configuration.GameObjectDepth;
+            }
+        }
+
 
         /// <summary>
         /// Instance of BacktraceApi that allows to send data to Backtrace API
@@ -193,8 +211,6 @@ internal ReportLimitWatcher ReportLimitWatcher
             }
         }
 
-        private int _gameObjectDepth = 0;
-
         private BacktraceLogManager _backtraceLogManager;
 
         public void OnDisable()
@@ -211,22 +227,21 @@ public void Refresh()
 
             Enabled = true;
 
-            // set maximum game object depth
-            _gameObjectDepth = Configuration.GameObjectDepth == 0
-                ? 16 // default maximum game object size
-                : Configuration.GameObjectDepth;
-
             CaptureUnityMessages();
             _reportLimitWatcher = new ReportLimitWatcher(Convert.ToUInt32(Configuration.ReportPerMin));
 
-#if UNITY_2018_4_OR_NEWER
 
             BacktraceApi = new BacktraceApi(
                 credentials: new BacktraceCredentials(Configuration.GetValidServerUrl()),
-                ignoreSslValidation: Configuration.IgnoreSslValidation);
+
+#if UNITY_2018_4_OR_NEWER
+                ignoreSslValidation: Configuration.IgnoreSslValidation
 #else
-            BacktraceApi = new BacktraceApi(new BacktraceCredentials(Configuration.GetValidServerUrl()));
+                ignoreSslValidation: false
 #endif
+                );
+            BacktraceApi.EnablePerformanceStatistics = Configuration.PerformanceStatistics;
+
             if (!Configuration.DestroyOnLoad)
             {
                 DontDestroyOnLoad(gameObject);
@@ -286,6 +301,7 @@ public void Send(string message, List<string> attachmentPaths = null, Dictionary
               attachmentPaths: attachmentPaths,
               attributes: attributes);
             _backtraceLogManager.Enqueue(report);
+
             SendReport(report);
         }
 
@@ -301,6 +317,7 @@ public void Send(Exception exception, List<string> attachmentPaths = null, Dicti
             {
                 return;
             }
+
             var report = new BacktraceReport(exception, attributes, attachmentPaths);
             _backtraceLogManager.Enqueue(report);
             SendReport(report);
@@ -344,8 +361,19 @@ private void SendReport(BacktraceReport report, Action<BacktraceResult> sendCall
         /// <returns>IEnumerator</returns>
         private IEnumerator CollectDataAndSend(BacktraceReport report, Action<BacktraceResult> sendCallback = null)
         {
+            var queryAttributes = new Dictionary<string, string>();
+            var stopWatch = EnablePerformanceStatistics
+                ? System.Diagnostics.Stopwatch.StartNew()
+                : new System.Diagnostics.Stopwatch();
+
             BacktraceData data = SetupBacktraceData(report);
-            yield return new WaitForEndOfFrame();
+
+            if (EnablePerformanceStatistics)
+            {
+                stopWatch.Stop();
+                queryAttributes["performance.report"] = stopWatch.GetMicroseconds();
+            }
+
             if (BeforeSend != null)
             {
                 data = BeforeSend.Invoke(data);
@@ -356,38 +384,64 @@ private IEnumerator CollectDataAndSend(BacktraceReport report, Action<BacktraceR
             }
             BacktraceDatabaseRecord record = null;
 
-            // avoid serializing data twice
-            // if record is here we should try to send json data that are available in record
-            // otherwise we can still use BacktraceData.ToJson().
-            string json = string.Empty;
             if (Database != null)
             {
                 yield return new WaitForEndOfFrame();
+                if (EnablePerformanceStatistics)
+                {
+                    stopWatch.Restart();
+                }
                 record = Database.Add(data);
                 // handle situation when database refuse to store report.
                 if (record != null)
                 {
                     //Extend backtrace data with additional attachments from backtrace database
                     data = record.BacktraceData;
+                    if (EnablePerformanceStatistics)
+                    {
+                        stopWatch.Stop();
+                        queryAttributes["performance.database"] = stopWatch.GetMicroseconds();
+                    }
+
+
                     if (record.Duplicated)
                     {
                         yield break;
                     }
-                    json = record.BacktraceDataJson();
                 }
             }
-            if (string.IsNullOrEmpty(json))
+
+            yield return new WaitForEndOfFrame();
+            if (EnablePerformanceStatistics)
+            {
+                stopWatch.Restart();
+            }
+            // avoid serializing data twice
+            // if record is here we should try to send json data that are available in record
+            // otherwise we can still use BacktraceData.ToJson().            
+            string json = record != null
+                ? record.BacktraceDataJson()
+                : data.ToJson();
+
+            if (EnablePerformanceStatistics)
             {
-                json = data.ToJson();
+                stopWatch.Stop();
+                queryAttributes["performance.json"] = stopWatch.GetMicroseconds();
             }
+
             //backward compatibility 
             if (RequestHandler != null)
             {
                 yield return RequestHandler.Invoke(BacktraceApi.ServerUrl, data);
                 yield break;
             }
 
-            StartCoroutine(BacktraceApi.Send(json, data.Attachments, data.Deduplication, (BacktraceResult result) =>
+            if (data.Deduplication != 0)
+            {
+                queryAttributes["_mod_duplicate"] = data.Deduplication.ToString();
+            }
+
+            StartCoroutine(BacktraceApi.Send(json, data.Attachments, queryAttributes, (BacktraceResult result) =>
             {
                 if (record != null)
                 {
@@ -418,6 +472,7 @@ record = Database.Add(data);
         /// <returns>Backtrace data</returns>
         private BacktraceData SetupBacktraceData(BacktraceReport report)
         {
+
             // apply _mod fingerprint attribute when client should use
             // normalized exception message instead environment stack trace
             // for exceptions without stack trace.
@@ -440,8 +495,7 @@ private BacktraceData SetupBacktraceData(BacktraceReport report)
                 reportAttributes = _nativeClient.GetAttributes();
             }
 
-            var data = report.ToBacktraceData(reportAttributes, _gameObjectDepth);
-            return data;
+            return report.ToBacktraceData(reportAttributes, GameObjectDepth);
         }
 
 #if UNITY_ANDROID
@@ -619,7 +673,7 @@ private bool ValidClientConfiguration()
         /// <returns>true if client should skip report. Otherwise false.</returns>
         private bool ShouldSkipReport(ReportFilterType type, Exception exception, string message)
         {
-            return Configuration.ReportFilterType == type
+            return Configuration.ReportFilterType.HasFlag(type)
                 || (SkipReport != null && SkipReport.Invoke(type, exception, message));
 
         }

Runtime/BacktraceDatabase.cs

@@ -106,7 +106,7 @@ public DeduplicationStrategy DeduplicationStrategy
         /// </summary>
         public void Reload()
         {
-            
+
             // validate configuration
             if (Configuration == null)
             {
@@ -257,7 +257,7 @@ public BacktraceDatabaseRecord Add(BacktraceData data, bool @lock = true)
                 return null;
             }
             var record = BacktraceDatabaseContext.Add(data);
-            if(!@lock)
+            if (!@lock)
             {
                 record.Dispose();
             }
@@ -325,7 +325,7 @@ public void Flush()
         /// </summary>
         public void Send()
         {
-            if(!Enable || !BacktraceDatabaseContext.Any())
+            if (!Enable || !BacktraceDatabaseContext.Any())
             {
                 return;
             }
@@ -339,14 +339,28 @@ private void FlushRecord(BacktraceDatabaseRecord record)
             {
                 return;
             }
+            var stopWatch = Configuration.PerformanceStatistics
+                ? new System.Diagnostics.Stopwatch()
+                : System.Diagnostics.Stopwatch.StartNew();
+
             var backtraceData = record.BacktraceDataJson();
             Delete(record);
+            var queryAttributes = new Dictionary<string, string>();
+            if (Configuration.PerformanceStatistics)
+            {
+                stopWatch.Stop();
+                queryAttributes["performance.database.flush"] = stopWatch.GetMicroseconds();
+            }
+
             if (backtraceData == null)
             {
                 return;
             }
+
+            queryAttributes["_mod_duplicate"] = record.Count.ToString();
+
             StartCoroutine(
-                BacktraceApi.Send(backtraceData, record.Attachments, record.Count, (BacktraceResult result) =>
+                BacktraceApi.Send(backtraceData, record.Attachments, queryAttributes, (BacktraceResult result) =>
                 {
                     record = BacktraceDatabaseContext.FirstOrDefault();
                     FlushRecord(record);
@@ -355,6 +369,10 @@ record = BacktraceDatabaseContext.FirstOrDefault();
 
         private void SendData(BacktraceDatabaseRecord record)
         {
+            var stopWatch = Configuration.PerformanceStatistics
+               ? System.Diagnostics.Stopwatch.StartNew()
+               : new System.Diagnostics.Stopwatch();
+
             var backtraceData = record != null ? record.BacktraceDataJson() : null;
             //check if report exists on hard drive 
             // to avoid situation when someone manually remove data
@@ -364,8 +382,16 @@ private void SendData(BacktraceDatabaseRecord record)
             }
             else
             {
+                var queryAttributes = new Dictionary<string, string>();
+                if (Configuration.PerformanceStatistics)
+                {
+                    stopWatch.Stop();
+                    queryAttributes["performance.database.send"] = stopWatch.GetMicroseconds();
+                }
+                queryAttributes["_mod_duplicate"] = record.Count.ToString();
+
                 StartCoroutine(
-                     BacktraceApi.Send(backtraceData, record.Attachments, record.Count, (BacktraceResult sendResult) =>
+                     BacktraceApi.Send(backtraceData, record.Attachments, queryAttributes, (BacktraceResult sendResult) =>
                      {
                          if (sendResult.Status == BacktraceResultStatus.Ok)
                          {

Runtime/Common/MetricsHelper.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Diagnostics;
+
+namespace Backtrace.Unity.Common
+{
+    internal static class MetricsHelper
+    {
+        /// <summary>
+        /// Get performance info from stopwatch in micros
+        /// </summary>
+        /// <param name="stopwatch">Stop watch</param>
+        /// <returns>Elapsed time in μs</returns>
+        public static string GetMicroseconds(this Stopwatch stopwatch)
+        {
+            var elapsedTime = ((stopwatch.ElapsedTicks * 1000000) / Stopwatch.Frequency);
+            return Math.Max(1, elapsedTime).ToString();
+        }
+    }
+}