Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

Will use the standard BotServer authentication mechanism with appropriate role-based permissions.

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.