2025-12-03 19:56:35 -03:00
|
|
|
# Monitoring API
|
|
|
|
|
|
|
|
|
|
> *⚠️ Note: This API is not yet implemented and is planned for a future release.*
|
|
|
|
|
|
|
|
|
|
The Monitoring API will provide endpoints for real-time system monitoring, performance metrics, and health checks.
|
|
|
|
|
|
|
|
|
|
## Planned Features
|
|
|
|
|
|
|
|
|
|
- Real-time system metrics
|
|
|
|
|
- Performance monitoring
|
|
|
|
|
- Health check endpoints
|
|
|
|
|
- Alert configuration
|
|
|
|
|
- Log aggregation
|
|
|
|
|
- Resource usage tracking
|
|
|
|
|
- Service status monitoring
|
|
|
|
|
|
|
|
|
|
## Base URL (Planned)
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
http://localhost:8080/api/v1/monitoring
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Authentication
|
|
|
|
|
|
2025-12-12 23:18:36 -03:00
|
|
|
Will use the standard botserver authentication mechanism with appropriate role-based permissions.
|
2025-12-03 19:56:35 -03:00
|
|
|
|
|
|
|
|
## Endpoints (Planned)
|
|
|
|
|
|
|
|
|
|
### System Health
|
|
|
|
|
`GET /api/v1/monitoring/health`
|
|
|
|
|
|
|
|
|
|
### Performance Metrics
|
|
|
|
|
`GET /api/v1/monitoring/metrics`
|
|
|
|
|
|
|
|
|
|
### Service Status
|
|
|
|
|
`GET /api/v1/monitoring/services`
|
|
|
|
|
|
|
|
|
|
### Resource Usage
|
|
|
|
|
`GET /api/v1/monitoring/resources`
|
|
|
|
|
|
|
|
|
|
### Alert Configuration
|
|
|
|
|
`POST /api/v1/monitoring/alerts`
|
|
|
|
|
`GET /api/v1/monitoring/alerts`
|
|
|
|
|
|
|
|
|
|
### Log Stream
|
|
|
|
|
`GET /api/v1/monitoring/logs`
|
|
|
|
|
|
|
|
|
|
## Implementation Status
|
|
|
|
|
|
|
|
|
|
This API is currently in the planning phase. Check back in future releases for availability.
|
