RecurringBugCatcher 1.0.1

.NET Framework 4.6.1
There is a newer version of this package available.
See the version list below for details. 
dotnet add package RecurringBugCatcher --version 1.0.1
NuGet\Install-Package RecurringBugCatcher -Version 1.0.1
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="RecurringBugCatcher" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add RecurringBugCatcher --version 1.0.1
#r "nuget: RecurringBugCatcher, 1.0.1"
#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 RecurringBugCatcher as a Cake Addin
#addin nuget:?package=RecurringBugCatcher&version=1.0.1

// Install RecurringBugCatcher as a Cake Tool
#tool nuget:?package=RecurringBugCatcher&version=1.0.1

Recurring Bug Catcher

What does it do?

Sometimes, applications throw exceptions and whilst these are us usually handled and logged, they may go unnoticed for a period of time. Unnoticed exceptions can sometimes hide a problem that whilst not immediately apparent, could have significant negative impact on the software.

Recurring Bug Catcher monitors any handled exception you tell it to track and when a particular exception occurs multiple times, bug catcher will notify any one subscribed by email(subscribers are usually devs or support people). When the email notification is received, the developer can then go and consult the application's exception log to investigate, assess and troubleshoot as required.

The purpose of Recurring Bug Catcher is to reveal unnoticed recurring exceptions early in the piece to give developers a chance to address issues before users are impacted or before users become aware of the issue.

How to use it?

Add the NuGet package to any project of your choice.

C# Example

// Initialise the manager
var bugCatcherManager = BugCatcherManager.Get;

// Configure the SMTP parameters for sending a notification when the same exception keeps occurring
bugCatcherManager.ConfigureSmtp(
		smtpHost: "SmtpHostAdress",
		fromEmailAddress: "bugcatcher-notification@domain.com",
		toEmailAddress: "someone@domain.com",
		smtpPort: 25);

// Initialise the tracker
var bugCatcherApi = bugCatcherManager.BugCatcherApi();

// Example usage
// Tell Recurring Bug Catcher to track exceptions in catch blocks
try
{
	// Do something
}
catch (Exception exception)
{
	// 1. Log using your usual logging library
	// This log is what you would consult if you receive an email notification from Recurring Bug Catcher 
	myUsualLogger.Error($"{exception.Message}{exception.Exception});

	// 2. Tell bug tracker to monitor this exception
	// If same or similar text generated by $"{exception.Message}{exception.Exception}"
	// occurs multiple times (in this example 5 times) then a notification is generated
	BugCatcherApi.MonitorException($"{exception.Message}{exception.Exception}", threshold: 5);
}
Product Compatible and additional computed target framework versions.
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 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
1.0.3 701 4/29/2019
1.0.2 615 4/27/2019
1.0.1 604 4/27/2019
1.0.0 917 4/21/2019

Initial publication