You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Prepare a 2.1.10 release
* Include project path in the command
* Rename job name
* Define full path to the nuget package
* Use git tag value to find a package
* Echo package version and the final package directory
* use env
* Use github_ref
* Export to variable
* Additional export step
* Try to export a different way the version variable
* Display the git tag value
* Fix YAML
* Change the way how a step reads github tag
* Extract git tag via different option
* Use git tag to determine the package name
* Use different library name
* Cleanup the flow
* Print directory before publish
* Escape nuget api key
* Use secret directly in the command
* Use up to date nuget properties
* Remove deprecated option and include icon in the package
* Update README.md and csproj with a new icon location
* Changelog update
* Update CHANGELOG.md
Co-authored-by: Sebastian Alex <[email protected]>
* Update README.md
Co-authored-by: Sebastian Alex <[email protected]>
* Add a reference to the pull request
---------
Co-authored-by: Sebastian Alex <[email protected]>
<Description>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.</Description>
17
18
<Summary>Backtrace's integration with C# app allows customers to catch and report handled and unhandled C# exceptions to their Backtrace instance, instantly offering the ability to prioritize and debug errors.</Summary>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+17Lines changed: 17 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,23 @@
1
1
# Backtrace C# Release Notes
2
2
3
+
## Version 2.1.10 - 02.07.2024
4
+
5
+
Improvements:
6
+
- Updated dependencies to the latest verison.
7
+
- On uncaught exception, store a report in the database rather sending it to API. If the database is not available, try sending a report to the server (#36).
8
+
- Added `application.session`, `application.version`, `backtrace.agent` and `backtrace.version` attributes.
9
+
- Read `application.version` and `version` attributes only when the assembly is available.
10
+
- Added support for the `error.type` attribute (#42).
11
+
- Fixed the problem when the `guid` attribute value was set incorrectly (#43).
12
+
13
+
14
+
Maintenance:
15
+
- Removed codeql-analysis action
16
+
- Moved testing and building to Github action (#37, #40)
17
+
- Added a CICD pipeline for releasing a new version of libraries
18
+
3
19
## Version 2.1.9 - 08.06.2019
20
+
4
21
- Changed acces modifiers in `BacktraceData` object. With this change, `BeforeSend` event allows to change `Annotations`, `ThreadInformation` and `SourceCode` property
[Backtrace](http://backtrace.io/)'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.
- Light-weight C# client library that quickly submits C#/.NET exceptions and crashes to your Backtrace dashboard
55
55
- Can include callstack, system metadata, custom metadata, and file attachments (e.g. minidump) if needed.
@@ -60,7 +60,7 @@ catch(Exception exception){
60
60
- Fully customizable and extendable event handlers and base classes for custom implementations
61
61
- Available as a [NuGet Package](https://www.nuget.org/packages/Backtrace/) as well as a fully open-sourced [Github Release](https://github.com/backtrace-labs/backtrace-csharp/).
The [**Backtrace** library](https://www.nuget.org/packages/Backtrace/) is available on NuGet. You can read more about NuGet and how to download the packages [here](https://docs.microsoft.com/en-us/nuget/)
88
88
89
-
## Installing Backtrace via NuGet <aname="installation-nuget"></a>
89
+
## Installing Backtrace via NuGet
90
90
91
91
You can install Backtrace via NuGet using the following commands:
92
92
@@ -102,76 +102,9 @@ Linux/Mac OS X .NET Core CLI:
- Open `Program.cs` class in any **Backtrace Sample project** and replace `BacktraceCredential` constructor patemeters with with your `Backtrace endpoint URL` (e.g. https://xxx.sp.backtrace.io:6098) and `submission token`:
- You should see new errors in your Backtrace instance. Refresh the Project page or Query Builder to see new details in real-time.
125
-
126
-
## .NET Core command line <aname="sample-app-cli"></a>
127
-
128
-
You can use .NET Core's CLI to run sample project on Windows, Mac OS and Linux. To run a sample project using .NET Core CLI:
129
-
130
-
- While in solution directory, navigate to **Backtrace.Core** sample application:
131
-
132
-
```
133
-
cd Backtrace.Core
134
-
```
135
-
136
-
- Open `Program.cs` in project **Backtrace.Core** and replace `BacktraceCredential` constructor parameters with with your `Backtrace endpoint URL` (e.g. https://xxx.sp.backtrace.io:6098) and `submission token`:
- You should see new errors in your Backtrace instance. Refresh the Project page or Query Builder to see new details in real-time.
155
-
156
-
## Visual Studio for MacOS <aname="sample-app-vs-mac"></a>
157
-
158
-
- Open the **Backtrace** solution in Visual Studio, unload all projects except **Backtrace**, **Backtrace.Tests** and **Backtrace.Core**, and set **Backtrace.Core** as your startup project:
- Open `Program.cs` class in project **Backtrace.Core** and replace `BacktraceCredential` constructor parameters with with your `Backtrace endpoint URL` (e.g. https://xxx.sp.backtrace.io:6098) and `submission token`:
- You should see new errors in your Backtrace instance. Refresh the Project page or Query Builder to see new details in real-time.
171
-
172
-
# Documentation <aname="documentation"></a>
173
-
174
-
## Initialize a new BacktraceClient <aname="documentation-initialization"></a>
107
+
## Initialize a new BacktraceClient
175
108
176
109
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:
177
110
@@ -192,15 +125,15 @@ var configuration = new BacktraceClientConfiguration(credentials){
For more information on `BacktraceClientConfiguration` parameters please see <ahref="#architecture-BacktraceClient">Architecture</a> section.
128
+
For more information on `BacktraceClientConfiguration` parameters please see [Architecture](#architecture).
196
129
197
130
Notes:
198
131
199
132
- If parameter `reportPerMin` is equal to 0, there is no limit on the number of error reports per minute. When the `reportPerMin` cap is reached, `BacktraceClient.Send/BacktraceClient.SendAsync` method will return false,
200
133
- If you develop application behind the proxy you can pass `WebProxy` object to `BacktraceCredentials` object. We will try to use `WebProxy` object when user pass it to `Backtrace`. To setup proxy use property `Proxy`,
201
134
-`BacktraceClient` allows you to unpack `AggregateExceptions` and send only exceptions that are available in `InnerException` property of `AggregateException`. By default `BacktraceClient` will send `AggregateException` information to Backtrace server. To avoid sending these reports, please override `UnpackAggregateException` and set value to `true`.
`BacktraceClient` allows you to customize the initialization of `BacktraceDatabase` for local storage of error reports by supplying a `BacktraceDatabaseSettings` parameter, as follows:
206
139
@@ -258,7 +191,7 @@ Notes:
258
191
- `BacktarceDatabase` `Delete` methodwillremove record (with multiple deduplicated records) at the same time.
259
192
- You can override default hash method by using `GenerateHash` delegate available in `BacktraceDatabase` object. When you add your own method implementation, `BacktraceDatabase` won't use default deduplication mechanism.
260
193
261
-
## Sending an errorreport <a name="documentation-sending-report"></a>
194
+
## Sending an errorreport
262
195
263
196
`BacktraceClient.Send/BacktraceClient.SendAsync` method will send an error report to the Backtrace endpoint specified. There `Send` method is overloaded, see examples below:
Unhandled application exception handler will store your report in database. In case if you won't see your report in Backtrace, you will have to relaunch your application.
399
332
400
-
## Custom client and report classes <aname="documentation-customization"></a>
333
+
## Custom client and report classes
401
334
402
335
You can extend `BacktraceBase` to create your own Backtrace client and error report implementation. You can refer to `BacktraceClient` for implementation inspirations.
**`BacktraceReport`** is a class that describe a single error report. Keep in mind that `BacktraceClient` uses `CallingAssembly` method to retrieve information about your application.
**`BacktraceClient`** is a class that allows you to instantiate a client instance that interacts with `BacktraceApi`. This class sets up connection to the Backtrace endpoint and manages error reporting behavior (for example, saving minidump files on your local hard drive and limiting the number of error reports per minute). `BacktraceClient` extends `BacktraceBase` class.
413
346
@@ -417,11 +350,11 @@ You can extend `BacktraceBase` to create your own Backtrace client and error rep
417
350
-`ClientAttributes` - custom attributes to be submitted to Backtrace alongside the error report.
418
351
-`ReportPerMin` - A cap on the number of reports that can be sent per minute. If `ReportPerMin` is equal to zero then there is no cap.
**`BacktraceData`** is a serializable class that holds the data to create a diagnostic JSON to be sent to the Backtrace endpoint via `BacktraceApi`. You can add additional pre-processors for `BacktraceData` by attaching an event handler to the `BacktraceClient.BeforeSend` event. `BacktraceData` require `BacktraceReport` and `BacktraceClient` client attributes.
**`BacktraceApi`** is a class that sends diagnostic JSON to the Backtrace endpoint. `BacktraceApi` is instantiated when the `BacktraceClient` constructor is called. You use the following event handlers in `BacktraceApi` to customize how you want to handle JSON data:
427
360
@@ -431,11 +364,11 @@ You can extend `BacktraceBase` to create your own Backtrace client and error rep
431
364
432
365
`BacktraceApi` can send synchronous and asynchronous reports to the Backtrace endpoint. To enable asynchronous report (default is synchronous) you have to set `AsynchronousRequest` property to `true`.
**`BacktraceResult`** is a class that holds response and result from a `Send` or `SendAsync` call. The class contains a `Status` property that indicates whether the call was completed (`OK`), the call returned with an error (`ServerError`), the call was aborted because client reporting limit was reached (`LimitReached`), or the call wasn't needed because developer use `UnpackAggregateException` property with empty `AggregateException` object (`Empty`). Additionally, the class has a `Message` property that contains details about the status. Note that the `Send` call may produce an error report on an inner exception, in this case you can find an additional `BacktraceResult` object in the `InnerExceptionResult` property.
**`BacktraceDatabase`** is a class that stores error report data in your local hard drive. If `DatabaseSettings` dones't contain a **valid**`DatabasePath` then `BacktraceDatabase` won't generate minidump files and store error report data.
441
374
@@ -455,11 +388,11 @@ stored reports every `RetryInterval` seconds up to `RetryLimit` times, both cust
455
388
456
389
If you want to clear your database or remove all reports after send method you can use `Clear`, `Flush` and `FlushAsync` methods.
**`ReportWatcher`** is a class that validate send requests to the Backtrace endpoint. If `reportPerMin` is set in the `BacktraceClient` constructor call, `ReportWatcher` will drop error reports that go over the limit. `BacktraceClient` check rate limit before `BacktraceApi` generate diagnostic json.
461
394
462
-
# Good to know <aname="good-to-know"></a>
395
+
# Good to know
463
396
464
397
## Xamarin
465
398
@@ -469,6 +402,6 @@ You can use this Backtrace library with Xamarin if you change your `HttpClient`
0 commit comments