Skip to content

Commit 7e25ec2

Browse files
Merge pull request #2 from HasanJaved-Developer/phase-2-logging
Phase 2 logging
2 parents 0719bf8 + a85a400 commit 7e25ec2

File tree

1 file changed

+35
-8
lines changed

1 file changed

+35
-8
lines changed

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
A centralized error logging and monitoring API built with **.NET 9**, Entity Framework Core, and SQL Server.
44
This project is designed to serve as a foundation for collecting, storing, and managing error logs from multiple applications.
55

6+
This project implements **Phase 1–3** (completed) and outlines future **Phase 4–6** enhancements.
7+
68
---
79

810
## 🚀 Features (Phase 1)
@@ -16,6 +18,26 @@ This project is designed to serve as a foundation for collecting, storing, and m
1618

1719
---
1820

21+
## 📌 Project Phases
22+
23+
### ✅ Phase 1: Core API
24+
- Create centralized logging API
25+
- Store logs in SQL Server
26+
- Basic Serilog integration
27+
- Swagger/OpenAPI setup
28+
29+
### ✅ Phase 2: Containerization
30+
- Add `Dockerfile`
31+
- Add `docker-compose.yml` for API + SQL Server
32+
- Persistent volumes for database
33+
34+
### ✅ Phase 3: Logging Enhancements
35+
- Structured logging with Serilog sinks
36+
- Support for File output
37+
- Correlation ID, environment, and service enrichment
38+
39+
---
40+
1941
## 📂 Project Structure
2042

2143
```bash
@@ -80,16 +102,21 @@ HTTP → http://localhost:5000/api
80102

81103
---
82104

83-
## 📌 Future Enhancements
105+
## 📈 Future Enhancements
106+
107+
### 🔒 Phase 4: User Management API
108+
- Authentication and Authorization using JWT
109+
- Role-based access for viewing logs
110+
- Claims-based authorization
84111

85-
- **Phase 2 – Logging Integration**
86-
- Add Serilog (file + SQL Server sink).
87-
- Middleware for capturing unhandled exceptions.
88-
- Structured JSON logging support.
112+
### 🐛 Phase 5: Try-Catch Integration
113+
- Using the centralized logging API in other apps
114+
- Capture and post exceptions automatically from services
89115

90-
- **Phase 3 – API Documentation**
91-
- Add Swagger / Swashbuckle for documentation.
92-
- Optionally generate client SDK with NSwag.
116+
### 🌐 Phase 6: Web Dashboard
117+
- Lightweight web app with login
118+
- Display logs from DB
119+
- Search & filter logs by date, service, environment, severity
93120

94121
---
95122

0 commit comments

Comments
 (0)