QuackAlert 1.0.3

quackalert

QuackAlert is a lightweight monitoring and alert library for .NET applications, designed to capture HTTP 5xx errors and send real-time email notifications.

Nuget: https://www.nuget.org/packages/QuackAlert/

✨ Features

• Automatic HTTP 5xx error capture
• Simple configuration via Options Pattern
• Request tracking with duration and timestamp

📦 Installation

dotnet add package QuackAlert

Or via NuGet Package Manager:

Install-Package QuackAlert

🚀 Quick Start

1. Configuration via appsettings.json (Recommended)

{
  "QuackAlert": {
    "Enabled": true,
    "Environment": "Production",
    "Email": {
      "SmtpHost": "smtp.gmail.com",
      "SmtpPort": 587,
      "SmtpUser": "your-email@gmail.com",
      "SmtpPassword": "your-app-password",
      "From": "your-email@gmail.com",
      "To": "recipient@email.com",
      "EnableSsl": true
    }
  }
}

And in Program.cs:

using QuackAlert.Extensions;
using QuackAlert.Enums;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddQuackAlert(options =>
{
    builder.Configuration.GetSection("QuackAlert").Bind(options);
});

var app = builder.Build();

// Add middleware
app.UseQuackAlert();

app.Run();

2. Configuration from Code

using QuackAlert.Extensions;
using QuackAlert.Enums;

var builder = WebApplication.CreateBuilder(args);

// Add QuackAlert
builder.Services.AddQuackAlert(options =>
{
    options.Enabled = true;
    options.Environment = EnvironmentType.Production;
    
    options.Email.SmtpHost = "smtp.gmail.com";
    options.Email.SmtpPort = 587;
    options.Email.SmtpUser = "your-email@gmail.com";
    options.Email.SmtpPassword = "your-app-password";
    options.Email.From = "your-email@gmail.com";
    options.Email.To = "recipient@email.com";
    options.Email.EnableSsl = true;
});

var app = builder.Build();

// Add middleware
app.UseQuackAlert();

app.Run();

⚙️ Configuration

QuackAlertOptions

EmailOptions

Note: Email sending is only activated when Enabled = true AND Environment = Production.

📊 What Gets Captured

QuackAlert automatically monitors:

• ✅ HTTP response status
• ✅ Request path
• ✅ HTTP method (GET, POST, etc.)
• ✅ Request timestamp
• ✅ Request duration in milliseconds
• ✅ Unhandled exceptions

Email Example

When a 5xx error occurs, you'll receive a formatted HTML email containing:

{
  "Timestamp": "2024-12-20T10:30:00Z",
  "Path": "/api/users",
  "Method": "POST",
  "StatusCode": 500,
  "DurationMs": 1250
}

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.