https://github.com/mreshboboyev/notifications-channel
Notifications.Channel is an asynchronous notification system built with .NET 9, MediatR, and OpenTelemetry. It uses channel-based publishers for efficient, non-blocking event processing, ensuring scalability, observability, and real-time notifications in distributed applications.
https://github.com/mreshboboyev/notifications-channel
asyncronous-messaging background-processing channels cloud-native docker event-driven-architecture event-handling logging mediatr microservices notifications observability open-telemetry pub-sub tracing
Last synced: 3 months ago
JSON representation
Notifications.Channel is an asynchronous notification system built with .NET 9, MediatR, and OpenTelemetry. It uses channel-based publishers for efficient, non-blocking event processing, ensuring scalability, observability, and real-time notifications in distributed applications.
- Host: GitHub
- URL: https://github.com/mreshboboyev/notifications-channel
- Owner: MrEshboboyev
- Created: 2025-02-25T13:16:27.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-02-25T14:02:41.000Z (3 months ago)
- Last Synced: 2025-02-25T14:41:44.851Z (3 months ago)
- Topics: asyncronous-messaging, background-processing, channels, cloud-native, docker, event-driven-architecture, event-handling, logging, mediatr, microservices, notifications, observability, open-telemetry, pub-sub, tracing
- Language: C#
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔔 Notifications.Channel – Scalable Asynchronous Notifications in .NET 9 🚀
## 🎯 Overview
**Notifications.Channel** is a **high-performance, asynchronous notification system** built with **.NET 9**, **MediatR**, and **OpenTelemetry**. This solution provides **event-driven messaging** using a **custom channel-based publisher**, ensuring **scalability, reliability, and observability** for real-time notifications.
> **Why Use Notifications.Channel?**
> - 🚀 **Asynchronous & Non-Blocking** – Uses **channels for efficient notification handling**.
> - 📡 **Event-Driven Design** – Implements **MediatR for pub/sub messaging**.
> - 🔎 **Built-in Observability** – Integrated with **OpenTelemetry** for tracing.
> - 🛠 **Docker-Ready & Scalable** – Deployable in **containerized environments**.
---
## 🌟 Features
✅ **.NET 9 Web API** – Built with the latest **ASP.NET Core framework**.
✅ **MediatR Integration** – Implements **publish-subscribe (pub/sub) messaging**.
✅ **Channel-Based Notifications** – Uses **custom channel publishers** for async handling.
✅ **Multiple Notification Handlers** – Supports **parallel processing**.
✅ **OpenTelemetry Tracing** – Provides **real-time observability**.
✅ **Docker Support** – Easily deploy with **Docker containers**.
---
## 🏗️ Architecture & Project Structure
📌 **src/Notifications.Channel/Program.cs** – Configures **MediatR, OpenTelemetry**, and API setup.
📌 **src/Notifications.Channel/ChannelPublisher.cs** – Implements the **custom channel-based publisher**.
📌 **src/Notifications.Channel/OrderCreatedNotification.cs** – Defines the **notification event**.
📌 **src/Notifications.Channel/NotificationHandlers/** – Contains **async notification handlers**.
---
## 🚀 Getting Started
### **📌 Prerequisites**
✅ [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0)
✅ [Docker](https://www.docker.com/) (optional for containerization)
### **Step 1: Clone the Repository**
```bash
git clone https://github.com/yourusername/Notifications.Channel.git
cd Notifications.Channel
```
### **Step 2: Build & Run the Application**
```bash
dotnet build
dotnet run --project src/Notifications.Channel
```
---
## 🐳 Running with Docker
### **Step 1: Build Docker Image**
```bash
docker build -t notifications-channel .
```
### **Step 2: Run Container**
```bash
docker run -p 8080:80 notifications-channel
```
> 🔹 **Docker allows easy deployment** in **cloud environments** or **microservices architectures**.
---
## 🌍 API Endpoints
| Method | Endpoint | Description |
|--------|-----------|-------------|
| **POST** | `/orders` | Creates a new order & triggers **OrderCreatedNotification** |
### **Example Request (cURL)**
```bash
curl -X POST http://localhost:8080/orders
```
> 📢 **When a new order is created**, the API **publishes an event** that triggers **multiple handlers** asynchronously.
---
## 🔎 OpenTelemetry Integration
This project is **pre-configured with OpenTelemetry** for **end-to-end tracing**, providing **real-time monitoring** of notifications.
🔹 **Features**:
✅ **ASP.NET Core Instrumentation** – Captures **request-response tracing**.
✅ **OTLP Exporter** – Sends telemetry data to **external observability platforms**.
✅ **Real-Time Monitoring** – View **end-to-end tracing** of notifications.
---
## 📨 MediatR & Asynchronous Notifications
### **How Notifications Work**
1️⃣ **Client sends a POST request to `/orders`**.
2️⃣ **MediatR publishes an `OrderCreatedNotification` event**.
3️⃣ **ChannelPublisher asynchronously processes notifications**.
4️⃣ **Multiple handlers consume the notification in parallel**.
### **Notification Handlers**
🔹 **OrderCreatedHandler** – Logs **order creation event**.
🔹 **SlowOrderCreatedHandler** – Simulates a **delayed event handler**.
🔹 **VerySlowOrderCreatedHandler** – Simulates a **long-running task**.
> ⚡ **Handlers process events independently** without blocking the main request.
---
## 🧪 Testing
### **Unit Tests**
Run tests to verify **notification handling and performance**:
```bash
dotnet test
```
### **Manual API Testing**
📌 **Use Postman or Swagger UI** to:
✅ **Create an order** → `/orders`
✅ **Check OpenTelemetry traces**
✅ **Verify async notification handling**
---
## 🎯 Why Use This Project?
✅ **High-Performance Asynchronous Notifications** – Reduces **blocking operations**.
✅ **Scalable & Fault-Tolerant** – Uses **channels & MediatR** for parallel execution.
✅ **Full Observability with OpenTelemetry** – Provides **tracing & monitoring**.
✅ **Production-Ready & Docker-Deployable** – Easily **scales in microservices**.
---
## 📜 License
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
---
## 📞 Contact
For feedback, contributions, or questions:
📧 **Email**: [email protected]
💻 **GitHub**: [MrEshboboyev](https://github.com/MrEshboboyev)
---
🚀 **Build scalable, event-driven APIs with Notifications.Channel!** Clone the repo & start now!