mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-10 03:51:54 +00:00
469d11fc7e
Add detailed API reference and update rollout playbook: **New: docs/api/SCHEDULER_HEALTH.md** - Complete endpoint reference for /api/monitoring/scheduler/health - Request/response structure with field descriptions - Enhanced "instances" array documentation - Example responses showing all states (healthy, transient, DLQ) - Useful jq queries for troubleshooting: - Find instances with errors - List DLQ entries - Show open circuit breakers - Sort by failure streaks - Migration guide (legacy → new fields) - Troubleshooting examples with real scenarios **Updated: docs/operations/ADAPTIVE_POLLING_ROLLOUT.md** - Enhanced "Accessing Scheduler Health API" section (§6) - Added examples using new instances[] array - Updated queries to use pollStatus, breaker, deadLetter fields - Practical jq commands for operators **Key Documentation Features:** - Complete JSON schema with examples - All new fields documented with types and descriptions - Real-world troubleshooting scenarios - Copy-paste ready jq queries - Migration path for existing integrations - Backward compatibility notes Operators can now: - Find error messages without log digging - Understand circuit breaker states - Track DLQ entries with full context - Diagnose issues using single API call Part of Phase 2 follow-up - enhanced observability |
||
|---|---|---|
| .. | ||
| api | ||
| development | ||
| images | ||
| monitoring | ||
| operations | ||
| security | ||
| API.md | ||
| CONFIGURATION.md | ||
| CONTRIBUTING-SCRIPTS.md | ||
| DOCKER.md | ||
| DOCKER_HUB_README.md | ||
| DOCKER_MONITORING.md | ||
| FAQ.md | ||
| frontend-style-guide.md | ||
| INSTALL.md | ||
| installer-v2-quickref.md | ||
| installer-v2-rollout.md | ||
| KUBERNETES.md | ||
| MIGRATION.md | ||
| OIDC.md | ||
| PORT_CONFIGURATION.md | ||
| PROXY_AUTH.md | ||
| PULSE_SENSOR_PROXY_HARDENING.md | ||
| RELEASE.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| script-library-guide.md | ||
| SECURITY.md | ||
| TEMPERATURE_MONITORING.md | ||
| TEMPERATURE_MONITORING_SECURITY.md | ||
| TROUBLESHOOTING.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| zfs-monitoring.md | ||