RootAlert 0.1.3
dotnet add package RootAlert --version 0.1.3
NuGet\Install-Package RootAlert -Version 0.1.3
<PackageReference Include="RootAlert" Version="0.1.3" />
paket add RootAlert --version 0.1.3
#r "nuget: RootAlert, 0.1.3"
// Install RootAlert as a Cake Addin #addin nuget:?package=RootAlert&version=0.1.3 // Install RootAlert as a Cake Tool #tool nuget:?package=RootAlert&version=0.1.3
🚀 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
📦 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
- Open Microsoft Teams and go to the desired channel.
- Click "…" (More options) → Connectors.
- Find "Incoming Webhook" and click "Configure".
- Name it RootAlert Notifications and click Create.
- Copy the Webhook URL and use it in
RootAlertOptions
.
🔹 Example Teams Alert (Adaptive Card)
RootAlert sends alerts as rich Adaptive Cards:
💬 Slack Integration
RootAlert supports Slack using Blocks & Sections for structured messages.
🔹 How to Get a Slack Webhook URL
- Go to https://api.slack.com/apps and create a new Slack App.
- Enable Incoming Webhooks under Features.
- Click "Add New Webhook to Workspace" and select a channel.
- Copy the Webhook URL and use it in
RootAlertOptions
.
🔹 Example Slack Alert (Blocks & Sections)
RootAlert sends Slack messages in a structured format:
⚙️ 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 | Versions 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. |
-
net6.0
- Microsoft.AspNetCore.Http (>= 2.3.0)
- Microsoft.Extensions.Logging (>= 9.0.1)
-
net7.0
- Microsoft.AspNetCore.Http (>= 2.3.0)
- Microsoft.Extensions.Logging (>= 9.0.1)
-
net8.0
- Microsoft.AspNetCore.Http (>= 2.3.0)
- Microsoft.Extensions.Logging (>= 9.0.1)
-
net9.0
- Microsoft.AspNetCore.Http (>= 2.3.0)
- Microsoft.Extensions.Logging (>= 9.0.1)
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 |
---|---|---|
0.1.3 | 10 | 2/6/2025 |