RootAlert 0.1.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package RootAlert --version 0.1.3
                    
NuGet\Install-Package RootAlert -Version 0.1.3
                    
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="RootAlert" Version="0.1.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RootAlert" Version="0.1.3" />
                    
Directory.Packages.props
<PackageReference Include="RootAlert" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RootAlert --version 0.1.3
                    
#r "nuget: RootAlert, 0.1.3"
                    
#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.
#:package RootAlert@0.1.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RootAlert&version=0.1.3
                    
Install as a Cake Addin
#tool nuget:?package=RootAlert&version=0.1.3
                    
Install as a Cake Tool

🚀 RootAlert - Real-time Exception Tracking for .NET

NuGet Badge 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.

⚠️ Note: This library is still in development and may undergo significant changes. Use it with caution in production environments.

🔥 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

📦 Installation

RootAlert is available on NuGet. Install it using:

 dotnet add package RootAlert --version 0.1.3

Or via Package Manager:

 Install-Package RootAlert -Version 0.1.3

⚡ Quick Start

1️⃣ Configure RootAlert in Program.cs

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

using RootAlert.Config;
using RootAlert.Extensions;

var builder = WebApplication.CreateBuilder(args);

var rootAlertOptions = new List<RootAlertOptions>
{
    new RootAlertOptions
    {
        AlertMethod = AlertType.Teams,
        WebhookUrl = "https://your-teams-webhook-url",
        BatchInterval = TimeSpan.FromMinutes(1)
    },
    new RootAlertOptions
    {
        AlertMethod = AlertType.Slack,
        WebhookUrl = "https://your-slack-webhook-url",
        BatchInterval = TimeSpan.FromMinutes(1)
    }
};

builder.Services.AddRootAlert(rootAlertOptions);

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!


⚠️ 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 via Adaptive Cards for structured error logging.

🔹 How to Get a Teams Webhook URL

  1. Open Microsoft Teams and go to the desired channel.
  2. Click "…" (More options) → Connectors.
  3. Find "Incoming Webhook" and click "Configure".
  4. Name it RootAlert Notifications and click Create.
  5. Copy the Webhook URL and use it in RootAlertOptions.

🔹 Example Teams Alert (Adaptive Card)

RootAlert sends alerts as rich Adaptive Cards:

Teams Adaptive Card


💬 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.

🔹 Example Slack Alert (Blocks & Sections)

RootAlert sends Slack messages in a structured format:

Slack Alert


⚙️ Configuration Options

Option Description
AlertMethod Teams or Slack (Choose alerting platform)
WebhookUrl Webhook URL for Teams or Slack
BatchInterval TimeSpan (e.g., TimeSpan.FromSeconds(30))
EmailSettings (Coming Soon) Configure SMTP for email alerts

🚨 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 SQL, Redis, or NoSQL
🔹 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

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on RootAlert:

Package Downloads
RootAlert.MSSQL

A Alert System for Exceptions .NET applications using MSSQL.

RootAlert.Redis

A Alert System for Exceptions .NET applications using Redis.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.6 303 3/22/2025
0.1.5 161 2/13/2025
0.1.4 163 2/10/2025
0.1.3 161 2/6/2025