Skip to content

Commit 5dc0f38

Browse files
Kamal Sai DevarapalliKamal Sai Devarapalli
authored andcommitted
Update documentation: remove airliner references
- Update MICROSERVICES_ARCHITECTURE.md: 'Airliner Administration' → 'EventStreamMonitor' - Update all endpoint URLs in documentation to use eventstreammonitor - Update MICROSERVICES_SETUP.md endpoint examples - Update LOAD_TEST_RESULTS.md and LOG_MONITORING_QUICKSTART.md endpoints - Update docs/redis_integration.md endpoint examples
1 parent 8581b6b commit 5dc0f38

File tree

6 files changed

+13
-14
lines changed

6 files changed

+13
-14
lines changed

LOAD_TEST_RESULTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
## Performance Results
1919

2020
### User Management Service
21-
**Endpoint:** `/api/v1/airliner/getUser/1000`
21+
**Endpoint:** `/api/v1/eventstreammonitor/users/1000`
2222

2323
| Metric | Value |
2424
|--------|-------|

LOG_MONITORING_QUICKSTART.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Real-Time Log Monitoring - Quick Start ## Quick Start ### 1. Start Services ```bash # Start all services including log monitor docker-compose up -d # Verify log monitor is running docker-compose ps logmonitor-service ``` ### 2. Access Dashboard Open your browser: **http://localhost:5004** The dashboard will automatically: - Show error statistics - Display recent errors - Auto-refresh every 5 seconds ### 3. Generate Test Errors ```bash # Trigger an error in a service curl -X POST http://localhost:5001/api/v1/airliner/registerUser \ -H "Content-Type: application/json" \ -d '{"invalid": "data"}' # Check dashboard - error should appear within 5 seconds ``` ## API Endpoints ### Get All Errors ```bash curl http://localhost:5004/api/v1/logs/errors?limit=50 ``` ### Get Statistics ```bash curl http://localhost:5004/api/v1/logs/stats ``` ### Get Errors by Service ```bash curl http://localhost:5004/api/v1/logs/errors/usermanagement ``` ## Verify Kafka Topics ```bash # List topics docker-compose exec kafka kafka-topics --list --bootstrap-server localhost:9092 # Should see: # - application-logs # - application-logs-errors # Consume logs docker-compose exec kafka kafka-console-consumer \ --bootstrap-server localhost:9092 \ --topic application-logs-errors \ --from-beginning ``` ## Grafana Setup 1. Install Grafana (or use Docker): ```bash docker run -d -p 3000:3000 grafana/grafana ``` 2. Add Data Source: - Type: JSON API - URL: http://localhost:5004/api/v1/grafana - Access: Server 3. Create Dashboard: - Add panel with query: `error_count` - Add panel with query: `error_by_service` - Add panel with query: `error_by_level` ## Features - Real-time error monitoring - Multi-service log collection - Automatic error filtering - Beautiful dashboard - Grafana integration - REST API for automation ## Why This Shines 1. **DevOps Skills**: Shows understanding of monitoring and observability 2. **Real-Time Processing**: Demonstrates event-driven architecture 3. **Production Ready**: Error handling, resilience, scalability 4. **Modern Stack**: Kafka, Python, Grafana - industry standard tools ## Next Steps 1. View dashboard: http://localhost:5004 2. Check API: http://localhost:5004/api/v1/logs/stats 3. Set up Grafana dashboards 4. Add alerting for critical errors For detailed documentation, see `docs/log_monitoring_system.md`
1+
# Real-Time Log Monitoring - Quick Start ## Quick Start ### 1. Start Services ```bash # Start all services including log monitor docker-compose up -d # Verify log monitor is running docker-compose ps logmonitor-service ``` ### 2. Access Dashboard Open your browser: **http://localhost:5004** The dashboard will automatically: - Show error statistics - Display recent errors - Auto-refresh every 5 seconds ### 3. Generate Test Errors ```bash # Trigger an error in a service curl -X POST http://localhost:5001/api/v1/eventstreammonitor/users/register \ -H "Content-Type: application/json" \ -d '{"invalid": "data"}' # Check dashboard - error should appear within 5 seconds ``` ## API Endpoints ### Get All Errors ```bash curl http://localhost:5004/api/v1/logs/errors?limit=50 ``` ### Get Statistics ```bash curl http://localhost:5004/api/v1/logs/stats ``` ### Get Errors by Service ```bash curl http://localhost:5004/api/v1/logs/errors/usermanagement ``` ## Verify Kafka Topics ```bash # List topics docker-compose exec kafka kafka-topics --list --bootstrap-server localhost:9092 # Should see: # - application-logs # - application-logs-errors # Consume logs docker-compose exec kafka kafka-console-consumer \ --bootstrap-server localhost:9092 \ --topic application-logs-errors \ --from-beginning ``` ## Grafana Setup 1. Install Grafana (or use Docker): ```bash docker run -d -p 3000:3000 grafana/grafana ``` 2. Add Data Source: - Type: JSON API - URL: http://localhost:5004/api/v1/grafana - Access: Server 3. Create Dashboard: - Add panel with query: `error_count` - Add panel with query: `error_by_service` - Add panel with query: `error_by_level` ## Features - Real-time error monitoring - Multi-service log collection - Automatic error filtering - Beautiful dashboard - Grafana integration - REST API for automation ## Why This Shines 1. **DevOps Skills**: Shows understanding of monitoring and observability 2. **Real-Time Processing**: Demonstrates event-driven architecture 3. **Production Ready**: Error handling, resilience, scalability 4. **Modern Stack**: Kafka, Python, Grafana - industry standard tools ## Next Steps 1. View dashboard: http://localhost:5004 2. Check API: http://localhost:5004/api/v1/logs/stats 3. Set up Grafana dashboards 4. Add alerting for critical errors For detailed documentation, see `docs/log_monitoring_system.md`

MICROSERVICES_ARCHITECTURE.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Microservices Architecture
22

33
## Overview
4-
This document describes the microservices architecture for the Airliner Administration system.
4+
This document describes the microservices architecture for the EventStreamMonitor system.
55

66
## Services
77

@@ -10,8 +10,7 @@ This document describes the microservices architecture for the Airliner Administ
1010
- **Port**: 5001 (9091 internal)
1111
- **Database**: `REGISTRATIONS` (PostgreSQL)
1212
- **Endpoints**:
13-
- `POST /api/v1/airliner/registerUser` - Register new user
14-
- (Note: Other endpoints may use different URL patterns - check service code for current routes)
13+
- `POST /api/v1/eventstreammonitor/users/register` - Register new user
1514
- **gRPC**: User validation for token generation
1615
- **Kafka**: Publishes user registration events
1716

@@ -20,8 +19,8 @@ This document describes the microservices architecture for the Airliner Administ
2019
- **Port**: TBD
2120
- **Database**: Separate PostgreSQL database
2221
- **Endpoints**:
23-
- `POST /api/v1/airliner/login` - User login (check service code for current routes)
24-
- `POST /api/v1/airliner/generateToken` - Generate JWT token (check service code for current routes)
22+
- `POST /api/v1/eventstreammonitor/auth/login` - User login (check service code for current routes)
23+
- `POST /api/v1/eventstreammonitor/auth/generateToken` - Generate JWT token (check service code for current routes)
2524
- **gRPC**: Token validation service
2625

2726
### 3. Task Processing Service

MICROSERVICES_SETUP.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Microservices Setup Guide
22

33
## Overview
4-
This guide explains how to set up and run all microservices in the Airliner Administration system.
4+
This guide explains how to set up and run all microservices in the EventStreamMonitor system.
55

66
## Services Architecture
77

88
### 1. User Management Service
99
- **Port**: 5001 (external), 9091 (internal)
1010
- **Database**: `REGISTRATIONS` (PostgreSQL on port 3304)
1111
- **Endpoints**:
12-
- `POST /api/v1/airliner/registerUser` - Register new user
12+
- `POST /api/v1/eventstreammonitor/users/register` - Register new user
1313
- **Kafka**: Publishes to `user-registration-events` topic
1414

1515
### 2. Task Processing Service (formerly Booking Service)
@@ -83,7 +83,7 @@ docker-compose logs -f notification-service
8383

8484
### Test User Registration
8585
```bash
86-
curl -X POST http://localhost:5001/api/v1/airliner/registerUser \
86+
curl -X POST http://localhost:5001/api/v1/eventstreammonitor/users/register \
8787
-H "Content-Type: application/json" \
8888
-H "Accept: application/json" \
8989
-H "Host: localhost:5001" \

docs/redis_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ from app.redis_helper import UserManagementRedisHelper
258258

259259
redis_helper = UserManagementRedisHelper()
260260

261-
@app.route('/api/v1/airliner/registerUser', methods=['POST'])
261+
@app.route('/api/v1/eventstreammonitor/users/register', methods=['POST'])
262262
def register_user():
263263
# Get client IP or user ID for rate limiting
264264
client_id = request.remote_addr # or user_id if authenticated

services/usermanagement/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Microservice responsible for user registration, user data management, and user v
1111
- Kafka producer for user events
1212

1313
## API Endpoints
14-
- `POST /api/v1/airliner/registerUser` - Register new user
15-
- `GET /api/v1/airliner/getUser/<id>` - Get user information
16-
- `DELETE /api/v1/airliner/deleteUser/<id>` - Delete user
14+
- `POST /api/v1/eventstreammonitor/users/register` - Register new user
15+
- `GET /api/v1/eventstreammonitor/users/<id>` - Get user information
16+
- `DELETE /api/v1/eventstreammonitor/users/<id>` - Delete user
1717

1818
## Configuration
1919
Copy `.env.example` to `.env` and update with your configuration.

0 commit comments

Comments
 (0)