Backtrace 1.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Backtrace --version 1.1.0
NuGet\Install-Package Backtrace -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Backtrace" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Backtrace --version 1.1.0
#r "nuget: Backtrace, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Backtrace as a Cake Addin
#addin nuget:?package=Backtrace&version=1.1.0

// Install Backtrace as a Cake Tool
#tool nuget:?package=Backtrace&version=1.1.0

Backtrace

Backtrace's integration with C# applications allows customers to capture and report handled and unhandled C# exceptions to their Backtrace instance, instantly offering the ability to prioritize and debug software errors.

Usage

var backtraceCredentials = 
	new BacktraceCredentials(@"https://myserver.sp.backtrace.io:6097", "4dca18e8769d0f5d10db0d1b665e64b3d716f76bf182fbcdad5d1d8070c12db0");
	// replace with your endpoint url and token

var backtraceClient = new BacktraceClient(backtraceCredentials);

try{
    //throw exception here
}
catch(Exception exception){
    backtraceClient.Send(new BacktraceReport(exception));
}

Prerequisites

  • On Windows, we recommend Visual Studio 2017 or above for IDE. You can download and install Visual Studio here. As an alternative to Visual Studio you can use .NET Core command line interface, see installation guide here
  • On Mac OS X, you can download and install Visual Studio here if you prefer using an IDE. For command line, you should to download and install .NET Core 2.0 or above.
  • On Linux, Visual Studio Code is available as a light-weight IDE. Similarly, you can use .NET Core command line interface, see instruction for Linux here

Documentation

Initialize a new BacktraceClient

First create a BacktraceCredential instance with your Backtrace endpoint URL (e.g. https://xxx.sp.backtrace.io:6098) and submission token, and supply it as a parameter in the BacktraceClient constructor:

var credentials = new BacktraceCredentials("backtrace_endpoint_url", "token");
var backtraceClient = new BacktraceClient(credentials);

Additionally and optionally, BacktraceClient constructor also accepts the following parameters: custom attributes, database directory path and maximum number of error reports per minute.

var backtraceClient = new BacktraceClient(
    sectionName: "BacktraceCredentials",
    attributes: new Dictionary<string, object>() { { "Attribute", "value" } },
    databaseDirectory: "pathToDatabaseDirectory",
    reportPerMin: 0
);

Sending an error report

BacktraceClient.Send method will send an error report to the Backtrace endpoint specified. There Send method is overloaded, see examples below:

Using BacktraceReport

The BacktraceReport class extends BacktraceReportBase and represents a single error report. (Optional) You can also submit custom attributes using the attributes parameter, or attach files by supplying an array of file paths in the attachmentPaths parameter.

try
{
  //throw exception here
}
catch (Exception exception)
{
    var report = new BacktraceReport(
        exception: exception,
        attributes: new Dictionary<string, object>() { { "key", "value" } },
        attachmentPaths: new List<string>() { @"file_path_1", @"file_path_2" }
    );
    var result = backtraceClient.Send(backtraceReport);
}
Asynchronous Send Support

For developers that use .NET 4.5+ and .NET Standard we recommend using SendAsync method, which uses asynchourous Tasks. Both Send and SendAsync method returns BacktraceResult. See example below:

try
{
  //throw exception here
}
catch (Exception exception)
{
    var report = new BacktraceReport(
        exception: exception,
        attributes: new Dictionary<string, object>() { { "key", "value" } },
        attachmentPaths: new List<string>() { @"file_path_1", @"file_path_2" }
    );
    var result = await backtraceClient.SendAsync(backtraceReport);
}

Other BacktraceReport Overloads

BacktraceClient can also automatically create BacktraceReport given an exception or a custom message using the following overloads of the BacktraceClient.Send method:

try
{
  //throw exception here
}
catch (Exception exception)
{
  backtraceClient.Send(exception);
  await backtraceClient.SendAsync("Message");
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net35 is compatible.  net40 was computed.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.9 66,786 6/8/2020
2.1.8 984 3/26/2020
2.1.7 15,613 3/2/2020
2.1.6 739 10/11/2019
2.1.5 541 10/4/2019
2.1.4 821 8/2/2019
2.1.3 863 6/13/2019
2.1.2 863 6/7/2019
2.1.1 1,241 3/18/2019
2.1.0 852 3/12/2019
2.0.7 1,028 2/14/2019
2.0.6 1,288 12/19/2018
2.0.5 997 12/14/2018
2.0.4 1,217 9/24/2018
2.0.3 1,170 9/4/2018
2.0.2 1,023 8/28/2018
2.0.1 1,310 7/17/2018
2.0.0 1,206 7/10/2018
1.3.2 1,301 7/3/2018
1.3.1 1,312 6/28/2018
1.3.0 1,308 6/26/2018
1.2.3 1,363 6/21/2018
1.2.2 1,432 6/19/2018
1.2.1 1,297 6/14/2018
1.2.0 1,439 5/5/2018
1.1.4 1,223 4/27/2018
1.1.2 1,221 4/9/2018
1.1.1 1,264 4/9/2018
1.1.0 1,337 4/2/2018
1.0.3 1,315 3/20/2018

- BacktraceClient now supports an asynchronously SendAsync method that works with async task
- For .NET Framework 4.5 and .NET Standard 2.0, BacktraceClient now streams file attachment content directly from disk via SendAsync method.
- AfterSend event parameter changed. Now AfterSend event require BacktraceResult parameter, not BacktraceReport,
- Send and SendAsync method now returns BacktraceResult with information about report state,
- OnServerResponse now require BacktraceResult as a parameter.