Skip to content

Commit ac81aaa

Browse files
Kamal Sai DevarapalliKamal Sai Devarapalli
authored andcommitted
docs: Update README with health endpoints and recent fixes
- Add Health Check Endpoints section with curl examples - Document /health endpoint for all services - Update Recent Updates section with build fixes - Add health check command to Quick Start guide
1 parent 6361d4c commit ac81aaa

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@ docker-compose up -d
181181

182182
# Verify services are running
183183
docker-compose ps
184+
185+
# Check service health
186+
python3 scripts/health_check.py
184187
```
185188

186189
### Access Services
@@ -190,6 +193,29 @@ docker-compose ps
190193
- **Task Processing API**: http://localhost:5002
191194
- **Notification API**: http://localhost:5003
192195

196+
### Health Check Endpoints
197+
198+
All services expose a `/health` endpoint for monitoring:
199+
200+
```bash
201+
# Check service health
202+
curl http://localhost:5001/health # User Management
203+
curl http://localhost:5002/health # Task Processing
204+
curl http://localhost:5003/health # Notification
205+
curl http://localhost:5004/health # Log Monitor
206+
207+
# Or use the health check script
208+
python3 scripts/health_check.py
209+
```
210+
211+
Expected response:
212+
```json
213+
{
214+
"status": "healthy",
215+
"service": "usermanagement"
216+
}
217+
```
218+
193219
### Test Error Streaming
194220

195221
```bash
@@ -336,6 +362,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
336362
## Recent Updates
337363

338364
I've been working on improving the project:
365+
- Added `/health` endpoints to all services for monitoring and health checks
366+
- Fixed import path issues and build errors across the codebase
367+
- Added default values for environment variables to improve service startup reliability
339368
- Added a comprehensive health check utility script
340369
- Improved documentation and added CHANGELOG.md for better tracking
341370
- Enhanced .gitignore and development tools

0 commit comments

Comments
 (0)