RootAlert 0.1.5

🚀 RootAlert - Real-time Exception Tracking for .NET

RootAlert is a lightweight real-time error tracking and alerting library for .NET applications. It captures unhandled exceptions, batches them intelligently, and sends alerts to Microsoft Teams and Slack.

🔥 Features

• 🛠 Automatic exception handling via middleware
• 🚀 Real-time alerts with batching to prevent spam
• 📡 Supports Microsoft Teams (Adaptive Cards) & Slack (Blocks & Sections)
• ⏳ Customizable batch interval using TimeSpan
• 📩 Rich error logs including request details, headers, and stack traces
• 🔗 Supports Redis for persistent storage

📦 Installation

RootAlert is available on NuGet. Install it using:

 dotnet add package RootAlert --version 0.1.5

Or via Package Manager:

 Install-Package RootAlert -Version 0.1.5

⚡ Quick Start

1️⃣ Configure RootAlert in Program.cs

Add RootAlert to your services and configure it to send alerts to Microsoft Teams or Slack.

If you do not configure a storage option, RootAlert will default to in-memory storage.

using RootAlert.Config;
using RootAlert.Extensions;
using RootAlert.Storage;

var builder = WebApplication.CreateBuilder(args);

var rootAlertOptions = new List<RootAlertOption>
{
    new RootAlertOption
    {
        AlertMethod = AlertType.Teams,
        WebhookUrl = "https://your-teams-webhook-url"
    },
    new RootAlertOption
    {
        AlertMethod = AlertType.Slack,
        WebhookUrl = "https://your-slack-webhook-url"
    }
};

var rootAlertSetting = new RootAlertSetting
{
    BatchInterval = TimeSpan.FromSeconds(20),
    RootAlertOptions = rootAlertOptions,
};

builder.Services.AddRootAlert(rootAlertSetting);

var app = builder.Build();

// ✅ Handle exceptions first
app.UseMiddleware<ExceptionHandlingMiddleware>();

// ✅ Then, log errors with RootAlert
app.UseRootAlert();

app.UseRouting();
app.UseEndpoints(endpoints => { endpoints.MapControllers(); });

app.Run();

✅ Now, RootAlert will automatically capture all unhandled exceptions!

⚡ Redis Storage for Persistent Error Logging

RootAlert supports Redis-based storage, ensuring that errors are not lost even if the application restarts.

🛠 Configuring Redis Storage

To use Redis as the error storage backend, configure RootAlertSetting as shown:

var rootAlertSetting = new RootAlertSetting
{
    Storage = new RedisAlertStorage("127.0.0.1:6379"),
    BatchInterval = TimeSpan.FromSeconds(20),
    RootAlertOptions = rootAlertOptions,
};

🔹 Why Use Redis Storage?

• ✅ Ensures logs persist even if the app restarts or the App Pool recycles.
• ✅ Allows centralized error tracking across multiple instances.
• ✅ Ideal for distributed applications that run across multiple servers.

⚠️ Important Notes

❗ If an exception filter is added, RootAlert won't work.

Reason: Exception filters handle errors before middleware gets a chance to process them. Since RootAlert works as middleware, it will never see the exception if a filter catches it first.

✅ Solution: Ensure RootAlert is added after any existing exception-handling middleware.

If your application has a global exception-handling middleware, register RootAlert after it to ensure exceptions are logged correctly. Example:

app.UseMiddleware<ExceptionHandlingMiddleware>(); // Your existing middleware
app.UseRootAlert(); // Register RootAlert after the exception middleware

🏆 Microsoft Teams Integration

RootAlert supports Microsoft Teams integration via:

1. Incoming Webhooks (Connector) – Simple and quick setup. (Will be deprecated)
2. Microsoft Teams Workflow API – Easier than Power Automate, with a built-in Webhook template.

💬 Slack Integration

RootAlert supports Slack using Blocks & Sections for structured messages.

🔹 How to Get a Slack Webhook URL

1. Go to https://api.slack.com/apps and create a new Slack App.
2. Enable Incoming Webhooks under Features.
3. Click "Add New Webhook to Workspace" and select a channel.
4. Copy the Webhook URL and use it in RootAlertOptions.

⚙️ Configuration Options

🚨 Example Error Alert

RootAlert captures rich error details including request details, headers, and stack traces:

🆔 Error ID: abc123
⏳ Timestamp: 02/05/2025 4:02:41 AM
----------------------------------------------------
🌐 REQUEST DETAILS
🔗 URL: /weatherforecast
📡 HTTP Method: GET
----------------------------------------------------
📩 REQUEST HEADERS
📝 User-Agent: Mozilla/5.0
----------------------------------------------------
⚠️ EXCEPTION DETAILS
❗ Type: DivideByZeroException
💬 Message: Attempted to divide by zero.
----------------------------------------------------
🔍 STACK TRACE
   at Program.Main() in Program.cs:line 54
   at RootAlertMiddleware.Invoke()
----------------------------------------------------

🛠 Roadmap

🔹 Database Storage - Store logs in MSSQL & Postgres

🔹 Email Alerts - Send exception reports via SMTP
🔹 Log Severity Filtering - Send only critical errors

📜 License

RootAlert is open-source and available under the MIT License.

💡 Contributing

🚀 Contributions are welcome! Feel free to submit pull requests or feature requests on GitHub.

🔗 Connect with Us

📧 Email: satsvelke@gmail.com
🐦 Twitter: @satsvelke