https://github.com/sergio0694/bigwatson
A complete, ligthweight and self-contained .NET Standard 2.0 offline exception logging library, powered by Realm
https://github.com/sergio0694/bigwatson
android-library asp-net aspnetcore csharp dll ios-lib netstandard netstandard20 realm uwp uwp-applications uwp-apps windows-10 windows-uwp xamarin xamarin-android xamarin-ios xamarin-library xamarin-studio
Last synced: 13 days ago
JSON representation
A complete, ligthweight and self-contained .NET Standard 2.0 offline exception logging library, powered by Realm
- Host: GitHub
- URL: https://github.com/sergio0694/bigwatson
- Owner: Sergio0694
- License: gpl-3.0
- Created: 2017-02-26T11:19:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-07T18:18:12.000Z (over 6 years ago)
- Last Synced: 2025-02-23T21:42:33.815Z (2 months ago)
- Topics: android-library, asp-net, aspnetcore, csharp, dll, ios-lib, netstandard, netstandard20, realm, uwp, uwp-applications, uwp-apps, windows-10, windows-uwp, xamarin, xamarin-android, xamarin-ios, xamarin-library, xamarin-studio
- Language: C#
- Homepage:
- Size: 287 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/BigWatson/) [](https://www.nuget.org/stats/packages/BigWatson?groupby=Version) [](https://ci.appveyor.com/project/Sergio0694/bigwatson) [](https://ci.appveyor.com/project/Sergio0694/bigwatson) [](https://twitter.com/SergioPedri)
A .NET Standard 2.0 library to easily log and review offline exception reports and messages for an app.
# Table of Contents
- [Installing from NuGet](#installing-from-nuget)
- [Quick start](#quick-start)
- [Setup](#setup)
- [Browse reports](#browse-reports)
- [Event logs](#event-logs)
- [External databases](#external-databases)
- [Dependencies](#dependencies)
- [Credits](#credits)
# Installing from NuGet
To install **BigWatson**, run the following command in the **Package Manager Console**
```
Install-Package BigWatson
```
More details available [here](https://www.nuget.org/packages/BigWatson).
## Quick start
The library exposes various APIs to easily log exceptions and then manage the logs database.
### Setup
The only thing that's needed to get started with the library is to add an event handler to log the exceptions:
```C#
this.UnhandledException += (s, e) => BigWatson.Instance.Log(e.Exception);
```
And that's it! The library will now automatically log every exception thrown by the app and build a complete database with all the crash reports and their useful info, including the app version and the app memory usage.
**NOTE:** on some frameworks, the APIs used by the library to retrieve the amount of used memory are not supported and will cause a crash at runtime. In order to solve this, the `BigWatson` class exposes a `Func MemoryParser` property that can be used to assign an arbitrary method, using the appropriate APIs for the target platform. Moreover, on some platforms it might be necessary to manually specify how to retrieve the correct app version as well. As an example, on UWP:
```C#
BigWatson.MemoryParser = () => (long)Windows.System.MemoryManager.AppMemoryUsage;
BigWatson.VersionParser = () =>
{
PackageVersion version = Package.Current.Id.Version;
return new Version(version.Major, version.Minor, version.Build, version.Revision);
};
```
### Browse reports
It is possible to load the complete list of previous exception reports, sorted by app versions, using:
```C#
var reports = await BigWatson.Instance.LoadExceptionsAsync();
```
To load only the reports of a specific type, just use the following overload:
```C#
var reports = await BigWatson.Instance.LoadExceptionsAsync();
```
It is also possible to trim the local exceptions database by deleting old reports that are no longer needed:
```C#
await BigWatson.Instance.TrimAsync(TimeSpan.FromDays(30));
```
### Event logs
Using **BigWatson** it is also possible to save event reports, which can be useful for analytics or debugging purposes:
```C#
BigWatson.Instance.Log(EventPriority.Info, "The user used the app 2 times today");
```
## External databases
If you want to share your crash reports database with someone else, or if you'd like your customers to be able to send their reports database to you, the library has some APIs to quickly share a database and load an external database file:
```C#
// Client-side
await BigWatson.Instance.ExportAsync(pathToExportDatabase);
// Developer side
IReadOnlyLogger logger = BigWatson.Load(pathToDatabase);
var reports = await logger.LoadExceptionsAsync();
```
## Dependencies
The libraries use the following libraries and NuGet packages:
* [Realm.Database](https://www.nuget.org/packages/Realm.Database/)
* [Newtonsoft.Json](https://www.nuget.org/packages/newtonsoft.json/)
* [Ben.Demystifier](https://www.nuget.org/packages/Ben.Demystifier/)
* [JetBrains.Annotations](https://www.nuget.org/packages/JetBrains.Annotations/)
## Credits
BigWatson UWP is an extension of the [LittleWatson](https://www.alexhardwicke.com/little-watson/) class by Alex Hardwicke. In addition to that, this updated library also includes an internal Realm database to store and retrieve previous logs, and additional APIs.
The icon base image was made by Aldric Rodríguez from [thenounproject.com](https://thenounproject.com/).