Breadcrumbs support

Editor/BacktraceConfigurationEditor.cs

@@ -8,6 +8,7 @@ namespace Backtrace.Unity.Editor
     [CustomEditor(typeof(BacktraceConfiguration))]
     public class BacktraceConfigurationEditor : UnityEditor.Editor
     {
+        protected static bool showBreadcrumbsSettings = false;
         protected static bool showEventAggregationSettings = false;
         protected static bool showClientAdvancedSettings = false;
         protected static bool showDatabaseSettings = false;
@@ -70,10 +71,6 @@ public override void OnInspectorGUI()
                        serializedObject.FindProperty("ReportFilterType"),
                        new GUIContent(BacktraceConfigurationLabels.LABEL_REPORT_FILTER));
 
-                EditorGUILayout.PropertyField(
-                    serializedObject.FindProperty("NumberOfLogs"),
-                    new GUIContent(BacktraceConfigurationLabels.LABEL_NUMBER_OF_LOGS));
-
                 EditorGUILayout.PropertyField(
                  serializedObject.FindProperty("PerformanceStatistics"),
                  new GUIContent(BacktraceConfigurationLabels.LABEL_PERFORMANCE_STATISTICS));
@@ -155,43 +152,64 @@ public override void OnInspectorGUI()
                         new GUIContent(BacktraceConfigurationLabels.LABEL_ADD_UNITY_LOG));
 
 #endif
+                }
 
-#if UNITY_ANDROID || UNITY_IOS
+                GUIStyle breadcrumbsSupportFoldout = new GUIStyle(EditorStyles.foldout);
+                showBreadcrumbsSettings = EditorGUILayout.Foldout(showBreadcrumbsSettings, BacktraceConfigurationLabels.LABEL_BREADCRUMBS_SECTION, breadcrumbsSupportFoldout);
+                if (showBreadcrumbsSettings)
+                {
+                    var enableBreadcrumbsSupport = serializedObject.FindProperty("EnableBreadcrumbsSupport");
                     EditorGUILayout.PropertyField(
-                         serializedObject.FindProperty("CaptureNativeCrashes"),
-                         new GUIContent(BacktraceConfigurationLabels.CAPTURE_NATIVE_CRASHES));
+                        enableBreadcrumbsSupport,
+                        new GUIContent(BacktraceConfigurationLabels.LABEL_ENABLE_BREADCRUMBS));
+
+                    if (enableBreadcrumbsSupport.boolValue)
+                    {
+                        EditorGUILayout.PropertyField(
+                            serializedObject.FindProperty("BacktraceBreadcrumbsLevel"),
+                            new GUIContent(BacktraceConfigurationLabels.LABEL_BREADCRUMBS_EVENTS));
+
+                        EditorGUILayout.PropertyField(
+                            serializedObject.FindProperty("LogLevel"),
+                            new GUIContent(BacktraceConfigurationLabels.LABEL_BREADCRUMNS_LOG_LEVEL));
+                    }
+                }
+
+#if UNITY_ANDROID || UNITY_IOS
+                EditorGUILayout.PropertyField(
+                    serializedObject.FindProperty("CaptureNativeCrashes"),
+                    new GUIContent(BacktraceConfigurationLabels.CAPTURE_NATIVE_CRASHES));
 #endif
-                    EditorGUILayout.PropertyField(
-                        serializedObject.FindProperty("AutoSendMode"),
-                        new GUIContent(BacktraceConfigurationLabels.LABEL_AUTO_SEND_MODE));
+                EditorGUILayout.PropertyField(
+                    serializedObject.FindProperty("AutoSendMode"),
+                    new GUIContent(BacktraceConfigurationLabels.LABEL_AUTO_SEND_MODE));
 
-                    EditorGUILayout.PropertyField(
-                        serializedObject.FindProperty("CreateDatabase"),
-                        new GUIContent(BacktraceConfigurationLabels.LABEL_CREATE_DATABASE_DIRECTORY));
+                EditorGUILayout.PropertyField(
+                    serializedObject.FindProperty("CreateDatabase"),
+                    new GUIContent(BacktraceConfigurationLabels.LABEL_CREATE_DATABASE_DIRECTORY));
 
-                    EditorGUILayout.PropertyField(
-                        serializedObject.FindProperty("GenerateScreenshotOnException"),
-                        new GUIContent(BacktraceConfigurationLabels.LABEL_GENERATE_SCREENSHOT_ON_EXCEPTION));
+                EditorGUILayout.PropertyField(
+                    serializedObject.FindProperty("GenerateScreenshotOnException"),
+                    new GUIContent(BacktraceConfigurationLabels.LABEL_GENERATE_SCREENSHOT_ON_EXCEPTION));
 
-                    SerializedProperty maxRecordCount = serializedObject.FindProperty("MaxRecordCount");
-                    EditorGUILayout.PropertyField(maxRecordCount, new GUIContent(BacktraceConfigurationLabels.LABEL_MAX_REPORT_COUNT));
+                SerializedProperty maxRecordCount = serializedObject.FindProperty("MaxRecordCount");
+                EditorGUILayout.PropertyField(maxRecordCount, new GUIContent(BacktraceConfigurationLabels.LABEL_MAX_REPORT_COUNT));
 
-                    SerializedProperty maxDatabaseSize = serializedObject.FindProperty("MaxDatabaseSize");
-                    EditorGUILayout.PropertyField(maxDatabaseSize, new GUIContent(BacktraceConfigurationLabels.LABEL_MAX_DATABASE_SIZE));
+                SerializedProperty maxDatabaseSize = serializedObject.FindProperty("MaxDatabaseSize");
+                EditorGUILayout.PropertyField(maxDatabaseSize, new GUIContent(BacktraceConfigurationLabels.LABEL_MAX_DATABASE_SIZE));
 
-                    SerializedProperty retryInterval = serializedObject.FindProperty("RetryInterval");
-                    EditorGUILayout.PropertyField(retryInterval, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_INTERVAL));
+                SerializedProperty retryInterval = serializedObject.FindProperty("RetryInterval");
+                EditorGUILayout.PropertyField(retryInterval, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_INTERVAL));
 
-                    EditorGUILayout.LabelField("Backtrace database require at least one retry.");
-                    SerializedProperty retryLimit = serializedObject.FindProperty("RetryLimit");
-                    EditorGUILayout.PropertyField(retryLimit, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_LIMIT));
+                EditorGUILayout.LabelField("Backtrace database require at least one retry.");
+                SerializedProperty retryLimit = serializedObject.FindProperty("RetryLimit");
+                EditorGUILayout.PropertyField(retryLimit, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_LIMIT));
 
-                    SerializedProperty retryOrder = serializedObject.FindProperty("RetryOrder");
-                    EditorGUILayout.PropertyField(retryOrder, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_ORDER));
-                }
+                SerializedProperty retryOrder = serializedObject.FindProperty("RetryOrder");
+                EditorGUILayout.PropertyField(retryOrder, new GUIContent(BacktraceConfigurationLabels.LABEL_RETRY_ORDER));
             }
+
             serializedObject.ApplyModifiedProperties();
         }
     }
-
 }

Editor/BacktraceConfigurationLabels.cs

@@ -11,22 +11,21 @@ internal static class BacktraceConfigurationLabels
         internal static string LABEL_SAMPLING = "Log random sampling rate";
         internal static string LABEL_HANDLE_ANR = "Handle ANR (Application not responding)";
 #if UNITY_ANDROID || UNITY_IOS
-        internal static string LABEL_HANDLE_OOM =
-#if UNITY_ANDROID
-            "(Early access) Send Low memory warnings to Backtrace";
-#elif UNITY_IOS
-            "(Early access) Send Out of memory exceptions to Backtrace";
-#endif
+        internal static string LABEL_HANDLE_OOM = "Send Out of Memory exceptions to Backtrace";
 #endif
 
         internal const string LABEL_ENABLE_EVENT_AGGREGATION = "Enable crash free metrics reporting";
         internal const string LABEL_EVENT_AGGREGATION_TIME_INTERVAL = "Auto send interval in sec";
         internal const string LABEL_CRASH_FREE_SECTION = "Crash Free Metrics Reporting";
 
+        internal const string LABEL_BREADCRUMBS_SECTION = "Breadcrumbs support";
+        internal const string LABEL_ENABLE_BREADCRUMBS = "Enable breadcrumbs support";
+        internal const string LABEL_BREADCRUMBS_EVENTS = "Breadcrumbs events type";
+        internal const string LABEL_BREADCRUMNS_LOG_LEVEL = "Breadcrumbs log level";
+
         internal static string LABEL_REPORT_ATTACHMENTS = "Report attachment paths";
         internal static string CAPTURE_NATIVE_CRASHES = "Capture native crashes";
         internal static string LABEL_REPORT_FILTER = "Filter reports";
-        internal static string LABEL_NUMBER_OF_LOGS = "Collect last n game logs";
         internal static string LABEL_GAME_OBJECT_DEPTH = "Game object depth limit";
         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";
@@ -47,6 +46,6 @@ internal static class BacktraceConfigurationLabels
         internal static string LABEL_MAX_DATABASE_SIZE = "Maximum database size (mb)";
         internal static string LABEL_RETRY_INTERVAL = "Retry interval";
         internal static string LABEL_RETRY_LIMIT = "Maximum retries";
-        internal static string LABEL_RETRY_ORDER = "Retry order (FIFO/LIFO)";
+        internal static string LABEL_RETRY_ORDER = "Retry order (FIFO/LIFO)";
     }
 }

README.md

@@ -177,7 +177,7 @@ The following is a reference guide to the Backtrace Client fields:
 - 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 option is available in Android and iOS build only. It allows to catch and report on ANR (application not responding) events happening in your game on mobile platform. See [here](#anr-reporting) for details.
-- (Early Access) Send out of memory exceptions to Backtrace - this option is available in Android and iOS build only. See [here](#oom-reporting) for details.
+- Send out of memory exceptions to Backtrace - this option is available in Android and iOS build only. See [here](#oom-reporting) for details.
 - 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.
 - Backtrace Database path: This is the path to directory where the Backtrace database will store reports on your game. You can use interpolated strings SUCH AS
   `${Application.persistentDataPath}/backtrace/database` to dynamically look up a known directory structure to use. NOTE: Backtrace database will remove all existing files in the database directory upion first initialization.
@@ -208,7 +208,7 @@ When configuring the backtrace-unity client for an Android deployment, programme
 
 The `error.type` for these reports will be `Hang`.
 
-## (Early Access) Out of Memory Reports <a name="oom-reporting"></a>
+## Out of Memory Reports <a name="oom-reporting"></a>
 
 Backtrace can detect and flag low memory conditions for Unity games running on Android devices. When low memory conditions are detected, two attributes will be set:
 
@@ -219,8 +219,6 @@ If the games does not recover from low memory conditions and the operating syste
 
 This functionality can be toggled on or off in the Backtrace configuration.
 
-Note that this functionality is released as 'early access' and will be functionally improved in the near future to aid root cause resolution.
-
 ## Symbols upload
 
 Unity allows developer to generate symbols archive called `symbols.zip` in the il2cpp build pipeline in the root directory of your game. In this archive you can find generated symbols for your game libraries. When your game crashes due to a native exception, your stack trace will contain only memory addresses instead of function name. Symbols from `symbols.zip` archive allows Backtrace to match function address to function name in your source code.
@@ -249,7 +247,7 @@ system and vm usage related information including system.memory.free, system.mem
 
 When configuring the backtrace-unity client for an iOS deployment, programmers will have a toggle available in the backtrace-unity GUI in the Unity Editor to enable or disable ANR or Hang reports. This will use the default of 5 seconds. The `error.type` for these reports will be `Hang`.
 
-## Out of Memory Reports (Early access)
+## Out of Memory Reports
 
 On iOS devices, when the operation system indicates there's memory pressure, Backtrace take a snapshot of the application state and persists it on the mobile device. When the operating system ends up killing the game, upon restart Backtrace will inspect the state file and deduce if the game was terminated because of memory pressure (for more information on the algorithm, see the [backtrace-cocoa repository](https://github.com/backtrace-labs/backtrace-cocoa#how-does-your-out-of-memory-detection-algorithm-work-)). If so, an error will be sent based on the data that was previously collected and persisted. Note that a snapshot will be taken every 2 minutes at most if low memory conditions persist.