Merge pull request #533 from MindscapeHQ/sean/11.0-changelog

v11.0.0 - Changelog

CHANGE-LOG.md

@@ -1,5 +1,19 @@
 # Full Change Log for Raygun4Net.* packages
 
+### v11.0.0
+- Add support for PDB Debug Information in stack traces
+  - This enables Raygun to leverage Portable PDBs to symbolicate .NET stack traces when PDBs are not included in the build output
+  - This introduces a dependency on `System.Reflection.Metadata@6.0.1` for `netstandard`
+  - See: https://github.com/MindscapeHQ/raygun4net/pull/528
+- Add support for storing crash reports offline
+  - There is a new `OfflineStore` property on `RaygunSettings`, when this is set, it will enable the offline storage
+  - Crashes are stored offline when there is a connectivity issue, or when the Raygun remote server returns a 5xx response
+  - There is a `IBackgroundSendStrategy`, which controls when to attempt to resend offline crash reports. It defaults to every 30 seconds
+  - By default, there is a maximum of 50 offline crashes stored
+  - See: https://github.com/MindscapeHQ/raygun4net/pull/530
+- Removed marking an unhandled exception in Android as handled, preventing the app from crashing
+  - See: https://github.com/MindscapeHQ/raygun4net/pull/531
+
 ### v10.1.2
 - Fix issue where uncaught exceptions could sometimes not be reported to Raygun
   - See: https://github.com/MindscapeHQ/raygun4net/pull/529

Mindscape.Raygun4Net.NetCore/README.md

@@ -99,6 +99,35 @@ Version numbering
 
 You can provide an application version value by setting the ApplicationVersion property of the RaygunClient (in the format x.x.x.x where x is a positive integer).
 
+Offline storage
+-----------------
+
+You can optionally specify an Offline Store for crash reports when creating your `RaygunClient`.
+
+When an offline store is specified, if there are any issues sending an exception to the Raygun API, a copy of the exception may be stored locally to be retried at a later date.
+
+An exception is stored offline when one of the following conditions are met:
+- There was a network connectivity issue, e.g. no active internet connection on a mobile device
+- The Raygun API responded with an HTTP 5xx, indicating an unexpected server error
+
+```csharp
+// Attempt to send any offline crash reports every 30 seconds
+var sendStrategy = new TimerBasedSendStrategy(TimeSpan.FromSeconds(30));
+
+// Store crash reports in Local AppData
+var offlineStore = new LocalApplicationDataCrashReportStore(sendStrategy);
+
+var raygunClient = new RaygunClient(new RaygunSettings()
+{
+  ApiKey = "paste_your_api_key_here",
+
+  // Optionally store 
+  OfflineStore = offlineStore
+});
+```
+
+You may extend and create your own custom implementations of `OfflineStoreBase` and `IBackgroundSendStrategy` to further customize where errors are stored, and when they are sent.
+
 Tags and custom data
 --------------------