https://github.com/vivekanand-vr/alertingsystem
Spring Boot application designed to monitor and track failed API requests and send alert notifications via email.
https://github.com/vivekanand-vr/alertingsystem
mongodb redis spring-mail
Last synced: about 1 month ago
JSON representation
Spring Boot application designed to monitor and track failed API requests and send alert notifications via email.
- Host: GitHub
- URL: https://github.com/vivekanand-vr/alertingsystem
- Owner: vivekanand-vr
- Created: 2024-12-18T15:31:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-28T09:08:52.000Z (over 1 year ago)
- Last Synced: 2025-01-09T19:05:13.578Z (over 1 year ago)
- Topics: mongodb, redis, spring-mail
- Language: Java
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alerting System for Monitoring Failed API Requests
### Overview
Spring Boot application for monitoring failed API requests with features:
- Request validation and caching
- Failed request logging
- IP-based alert system
- Redis caching for optimized performance
- Email notifications for multiple failed API requests
### Prerequisites
- Java 17, Maven, Redis, MongoDB, Gmail account (for SMTP email alerts)
### Technology Stack
- Spring Boot 3.2.1, Redis, MongoDB, Java Mail Sender, Lombok, Jackson JSR310
## Configuration Steps
### 1. Clone the Repository
```bash
git clone https://github.com/vivekanand-vr/alertingSystem.git
cd alertingSystem
```
### 2. Configure Server Values
- Create `application.properties`
- Add threshold and email address
- Add number of threads for handling traffic
```properties
# Alert Configuration
alert.threshold=5
alert.email=admin@email.com
# Server Configuration for High Traffic
server.tomcat.threads.max=200
server.tomcat.max-connections=10000
```
### 3. Setup Redis
- Install Redis
- Start Redis server
- Verify connection: `redis-cli ping`
```properties
# Redis Configuration
spring.redis.host=localhost
spring.redis.port=6379
# Jackson Configuration
spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
```
### 4. Configure MongoDB
- Open `src/main/resources/application.properties`
- Ensure MongoDB is running locally
- Default connection: `mongodb://localhost:27017/`
### 5. Configure Email Settings
- Open `src/main/resources/application.properties`
- Update email configuration:
```properties
spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email@gmail.com
spring.mail.password=your-app-password
```
### 6. Generate App Password for Gmail
- Go to Google Account
- Security > 2-Step Verification
- App Passwords > Select App (Mail) > Generate
- Use generated password in `application.properties`
### 7. Build and Run the Application
```bash
# Build the project
mvn clean package
# Run the application
mvn spring-boot:run
```
## API Endpoints
### 1. Submit Endpoint
- **URL:** `/api/submit`
- **Method:** POST
- **Required Headers:**
- `Authorization: Bearer FIXED_SECRET_TOKEN_2024`
- `X-Custom-Header: SomeValue`
- **Required Params:**
- `clientId`
- `version`
- **Request Body:** JSON with `name` and `description`
---
### 2. Metrics Endpoint
- **URL:** `/api/metrics`
- **Method:** GET
- Returns list of failed requests
## Example Request
```bash
curl -X POST "http://localhost:8080/api/submit?clientId=123&version=1.0" \
-H "Authorization: Bearer FIXED_SECRET_TOKEN_2024" \
-H "X-Custom-Header: SomeValue" \
-H "Content-Type: application/json" \
-d '{"name":"John Doe","description":"Sample Description"}'
```
## Architecture
- Failed requests cached in Redis (10-minute window)
- Batch writes to MongoDB on threshold breach
- Email alerts sent for suspicious activity
- Path validation for /api/submit endpoint
## Logging
- Failed requests are logged in MongoDB
- Email alerts sent when failure threshold is reached
## Email Notification Snapshot
## Customization
Modify `application.properties` to adjust:
- Alert threshold
- Alert email
- MongoDB connection
- SMTP settings
## Troubleshooting
- Verify Redis and MongoDB services
- Check SMTP credentials
- Confirm network configurations
- Monitor Redis cache status