Skip to content

dot-net-standard.md

Latest commit

 

History

History
116 lines (83 loc) · 3.99 KB

dot-net-standard.md

File metadata and controls

116 lines (83 loc) · 3.99 KB

.NET Standard

{% hint style="info" %} We have a new cross-platform .NET SDK available for early-access testing. If you're interested in using our latest SDK, please email support@bugsplat.com. {% endhint %}

Overview

BugSplatDotNetStandard lets you capture and track exceptions on all .NET Standard 2.0 platforms. This includes:

  • .NET 5+
  • .NET Framework
  • Maui
  • Mono
  • Unity

🏗 Installation

Install the BugSplatDotNetStandard NuGet package.

Install-Package BugSplatDotNetStandard

⚙️ Configuration

After you've installed the NuGet package, add a using statement for the BugSplatDotNetStandard namespace.

using BugSplatDotNetStandard;

Create a new instance of BugSplat, providing it with 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 various fields, including description, email, key, notes, user, file attachments, and attributes.

var bugsplat = new BugSplat(database, application, version);
bugsplat.Attachments.Add(new FileInfo("/path/to/attachment.txt"));
bugsplat.Description = "the default description";
bugsplat.Email = "fred@bugsplat.com";
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.

try
{
    throw new Exception("BugSplat rocks!");
}
catch(Exception ex)
{
    await bugsplat.Post(exception);
}

Additionally, Post can be used to upload minidumps to BugSplat.

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 the Post method. 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 100MB by default.

var options = new ExceptionPostOptions()
{
    Description = "BugSplat rocks!",
    Email = "fred@bugsplat.com",
    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 and ensure you have the 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.

User Feedback

In addition to crash reporting, BugSplat supports collecting non-crashing user feedback such as bug reports and feature requests. Feedback reports appear in BugSplat with the "User Feedback" type, grouped by title.

await bugsplat.PostFeedback("Login button broken", "Nothing happens when I tap it");

You can customize feedback submissions with FeedbackPostOptions:

var options = new FeedbackPostOptions()
{
    Email = "jane@example.com",
    User = "Jane",
    Key = "settings-page"
};
options.Attachments.Add(new FileInfo("/path/to/screenshot.png"));

await bugsplat.PostFeedback("UI rendering issue", "The sidebar overlaps the main content.", options);

👷 Support

If you have any additional questions, please email our support team, join us on Discord, or reach out via the chat in our web application.