Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mausworks/pidget
Error reporting for .NET using sentry.io
https://github.com/mausworks/pidget
aspnet dotnet-core error-reporting event-logging middleware sentry
Last synced: 3 months ago
JSON representation
Error reporting for .NET using sentry.io
- Host: GitHub
- URL: https://github.com/mausworks/pidget
- Owner: mausworks
- License: mit
- Created: 2017-10-28T20:49:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-08T14:23:03.000Z (over 2 years ago)
- Last Synced: 2024-10-12T12:47:24.583Z (3 months ago)
- Topics: aspnet, dotnet-core, error-reporting, event-logging, middleware, sentry
- Language: C#
- Homepage:
- Size: 805 KB
- Stars: 37
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PIDGET
[](https://travis-ci.org/mausworks/pidget)
[](https://codecov.io/gh/mausworks/pidget)
Pidget is an exception and error-reporting library for **[Sentry.io](https://sentry.io/)!**
If you are looking for extensive and configurable exception handling in ASP.NET Core, then have a look at the [ASP.NET Middleware](https://github.com/mausworks/pidget/tree/master/src/Pidget.AspNet). For most other applications you can use the [client](https://github.com/mausworks/pidget/tree/master/src/Pidget.Client).
If you have any questions, ideas or requests, please open a [new issue](https://github.com/mausworks/pidget/issues/new)!
## How is this different from SharpRaven?
- Pidget is async-first (for blocking calls use, e.g. `client.CaptureAsync([...]).Result`)
- Pidget is primarily targeted towards .NET Core
- Pidget aims to be modular and extensible, whereas SharpRaven is a bit more monolithic
- The Pidget client is a unopinionated minimalistic client, i.e. "it just sends stuff"
- The Pidget client uses a `HttpClient` as primary transfer mechanism, whereas SharpRaven uses a [`WebRequest`](https://github.com/getsentry/raven-csharp/blob/3c30a19c953744afb99ff4a618c6c97a062597e7/src/app/SharpRaven/Data/Requester.cs#L61-L85)
- The Pidget ASP.NET Middleware is specifically tailored for ASP.NET Core
## Can I use it?
Pidget targets [.NET Standard 2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support), which adds support for most (somewhat modern) .NET applications, e.g. .NET Core, Xamarin, Mono, UWP.
* * * *
## Pidget ASP.NET Middleware
Captures ASP.NET Core application errors and automatically attaches user & request data.
### [Features](https://docs.sentry.io/clientdev/overview/#writing-an-sdk)
- Support for Linux, Windows and OS X
- Automated error capturing (e.g. uncaught exception handlers)
- ~~Logging framework integration~~ (Can be configured with before/after-send hooks)
- Non-blocking event submission
- ~~Basic~~ **configurable** data sanitization (e.g. filtering out values that look like passwords)
- Context data helpers (e.g. setting the current user, recording breadcrumbs)
- Honor Sentry’s HTTP 429 Retry-After header
- Pre and Post event send hooks
**[Documentation & source](https://github.com/mausworks/pidget/tree/master/src/Pidget.AspNet)**
[](https://nuget.org/packages/Pidget.AspNet)
* * * *
## Pidget Client
An easy-to use Sentry client. Basic by design.
### [Features](https://docs.sentry.io/clientdev/overview/#writing-an-sdk)
- DSN configuration
- Graceful failures (e.g. Sentry server is unreachable)
- Setting attributes (e.g. tags and extra data)
- Support for Linux, Windows and OS X
- Non-blocking event submission
- Context data helpers (e.g. setting the current user, recording breadcrumbs)
- Event sampling
- **Not possible/viable:** Local variable values in stacktrace
**[Documentation & source](https://github.com/mausworks/pidget/tree/master/src/Pidget.Client)**
[](https://nuget.org/packages/Pidget.Client)