https://github.com/bugsplat-git/bugsplat-dotnet-standard
🌋📋🕵️ BugSplat error reporting for .NET Standard applications
https://github.com/bugsplat-git/bugsplat-dotnet-standard
bugsplat crash dotnet dotnet-core dotnet-framework dotnet-standard error exception reporting
Last synced: 3 months ago
JSON representation
🌋📋🕵️ BugSplat error reporting for .NET Standard applications
- Host: GitHub
- URL: https://github.com/bugsplat-git/bugsplat-dotnet-standard
- Owner: BugSplat-Git
- License: mit
- Created: 2019-03-28T22:30:35.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T23:30:20.000Z (9 months ago)
- Last Synced: 2024-09-17T04:00:57.115Z (9 months ago)
- Topics: bugsplat, crash, dotnet, dotnet-core, dotnet-framework, dotnet-standard, error, exception, reporting
- Language: C#
- Homepage: https://docs.bugsplat.com/introduction/getting-started/integrations/cross-platform/dot-net-standard
- Size: 1.1 MB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://bugsplat.com)
# BugSplat
### **Crash and error reporting built for busy developers.**
[](https://twitter.com/bugsplatco)
[](https://discord.gg/bugsplat)
## 👋 Introduction
BugSplatDotNetStandard allows you to capture and track exceptions on all platforms that support .NET Standard 2.0. This includes, .NET Core, Universal Windows Platform, Mono and more! Before continuing with the tutorial please make sure you have completed the following checklist:
- [Register](https://app.bugsplat.com/v2/sign-up) as a new BugSplat user.
- [Log in](https://app.bugsplat.com/cognito/login) using your email address.
You can also view the [MyUwpCrasher](https://github.com/BugSplat-Git/MyUwpCrasher) repo which contains a sample application with BugSplatDotNetStandard installed and configured to post exceptions to BugSplat.
## 🏗 Installation
Install the [BugSplatDotNetStandard](https://www.nuget.org/packages/BugSplatDotNetStandard/) NuGet package.
```ps
Install-Package BugSplatDotNetStandard
```
## ⚙️ Configuration
After you've installed the NuGet package, add a using statement for the `BugSplatDotNetStandard` namespace.
```cs
using BugSplatDotNetStandard;
```
Create a new instance of `BugSplat` providing it your database, application, and version. It's best to do this at the entry point of your application. Several defaults can be provided to BugSplat. You can provide default values for things such as description, email, key, notes, user, file attachments, and attributes.
```cs
var bugsplat = new BugSplat(database, application, version);
bugsplat.Attachments.Add(new FileInfo("/path/to/attachment.txt"));
bugsplat.Description = "the default description";
bugsplat.Email = "[email protected]";
bugsplat.Key = "the key!";
bugsplat.Notes = "the notes!";
bugsplat.User = "Fred";
bugsplat.Attributes.Add("key", "value");
```
The `Post` method can be used to send Exception objects to BugSplat.
```cs
try
{
throw new Exception("BugSplat rocks!");
}
catch(Exception ex)
{
await bugsplat.Post(exception);
}
```
Additionally, `Post` can be used to upload minidumps to BugSplat.
```cs
await bugsplat.Post(new FileInfo("/path/to/minidump.dmp"));
```
The default values for description, email, key and user can be overridden in the call to Post. Additional attachments can also be specified in the call to Post. If BugSplat can't read an attachment (e.g. the file is in use), it will be skipped. Please note that the total size of the Post body and all attachments is limited to **20MB** by default.
```cs
var options = new ExceptionPostOptions()
{
Description = "BugSplat rocks!",
Email = "[email protected]",
User = "Fred",
Key = "the key!"
};
options.Attachments.Add(new FileInfo("/path/to/attachment2.txt"));
await bugsplat.Post(ex, options);
```
## ✅ Verification
Once you've generated an error, navigate to the BugSplat [Dashboard](https://app.bugsplat.com/v2/dashboard) and ensure you have to correct database selected in the dropdown menu. You should see a new crash report under the **Recent Crashes** section:
Click the link in the **ID** column to see details about the crash:
That’s it! Your application is now configured to post crash reports to BugSplat.
## 👷 Support
If you have any additional questions, please email or [support](mailto:[email protected]) team, join us on [Discord](https://discord.gg/K4KjjRV5ve), or reach out via the chat in our web application.