Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kenny-io committed Dec 18, 2024
1 parent 4dca623 commit 9721d1f
Showing 1 changed file with 5 additions and 31 deletions.
36 changes: 5 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ A real-time monitoring system built with Next.js, Prometheus, and Express that t
## Features

- πŸ” Real-time service monitoring
- πŸ“Š Multiple time-frame views (minutes, hourly, daily, weekly, monthly)
- πŸ“ˆ Latency tracking and visualization
- πŸ”„ Automatic retry mechanism for failed requests
- 🚦 Status indicators with tooltips
Expand Down Expand Up @@ -49,12 +48,13 @@ A real-time monitoring system built with Next.js, Prometheus, and Express that t
- Service is considered "up" if:
- Response status is 200-299
- Response matches expected format/content
- More than 90% of checks in the interval are successful
- Downtime is less than 9 minutes -- Partial Outage
- Downtime is more than 9 minutes -- Full Outage

#### Refresh Intervals
- Minutes view: 60 second refresh
- Hourly view: 5 minute refresh
- Daily/Weekly/Monthly views: 1 hour refresh
- Latency: every second refresh
- Uptime: 5 minute refresh
- Realtime: 1 second refresh

## Setup

Expand Down Expand Up @@ -99,9 +99,6 @@ A real-time monitoring system built with Next.js, Prometheus, and Express that t
"expectedResponse": {
"field": "value"
},
"headers": {
"Authorization": "Bearer token"
},
"body": {
"key": "value"
}
Expand Down Expand Up @@ -136,29 +133,6 @@ A real-time monitoring system built with Next.js, Prometheus, and Express that t
└── scripts/ # Helper scripts
```

### Testing

1. **Test Environment**
```bash
npm run test
```
This starts:
- Test server (mock services)
- Prometheus exporter
- Next.js development server

2. **Test Endpoints**
- Located in `server/test-endpoints.json`
- Provides mock services for testing

## Timeframes and Data Points

- **Minutes**: 60 indicators (1 per minute)
- **Hourly**: 24 indicators (1 per hour)
- **Daily**: 30 indicators (1 per day)
- **Weekly**: 7 indicators (1 per week)
- **Monthly**: 12 indicators (1 per month)

## Error Handling

1. **Network Errors**
Expand Down

0 comments on commit 9721d1f

Please sign in to comment.