Skip to content

Commit 674818b

Browse files
Kamal Sai DevarapalliKamal Sai Devarapalli
authored andcommitted
Improve README formatting
1 parent b6e3bbe commit 674818b

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# EventStreamMonitor
22

3-
A real-time microservices monitoring platform with event streaming, error tracking, and live dashboard visualization.
3+
Real-time microservices monitoring platform with Kafka event streaming and error tracking.
44

5-
## Overview
5+
## What it does
66

7-
EventStreamMonitor collects logs from multiple microservices, streams them through Apache Kafka, filters errors automatically, and displays them in a real-time dashboard. Built with Python, Flask, Kafka, Redis, and PostgreSQL.
7+
EventStreamMonitor collects logs from multiple microservices, streams them through Kafka, filters errors automatically, and displays everything in a live dashboard. Useful for monitoring distributed systems and catching issues in real-time.
88

99
## Features
1010

11-
- Real-time log collection from multiple microservices
12-
- Event streaming with Apache Kafka
11+
- Real-time log collection from multiple services
12+
- Kafka-based event streaming
1313
- Automatic error filtering and tracking
1414
- Live monitoring dashboard
15-
- Redis caching and session management
15+
- Redis caching
1616
- Microservices architecture with Docker
1717

1818
## Quick Start
@@ -24,31 +24,23 @@ docker-compose up -d
2424
# Access dashboard
2525
open http://localhost:5004
2626

27-
# Stream test errors
27+
# Test error streaming
2828
python3 scripts/quick_stream_errors.py
2929
```
3030

3131
## Services
3232

3333
- **User Management** (Port 5001) - User registration and management
3434
- **Task Processing** (Port 5002) - Background task processing
35-
- **Notification** (Port 5003) - Event-driven notifications
35+
- **Notification** (Port 5003) - Event-driven notifications
3636
- **Log Monitor** (Port 5004) - Real-time error monitoring dashboard
3737

3838
## Tech Stack
3939

40-
- Python 3.9, Flask
41-
- Apache Kafka
42-
- Redis
43-
- PostgreSQL
44-
- Docker, Docker Compose
40+
Python, Flask, Apache Kafka, Redis, PostgreSQL, Docker
4541

4642
## Documentation
4743

4844
- [Quick Start Guide](QUICK_START.md)
4945
- [Architecture Overview](MICROSERVICES_ARCHITECTURE.md)
5046
- [Setup Guide](MICROSERVICES_SETUP.md)
51-
52-
## License
53-
54-
MIT

0 commit comments

Comments
 (0)