docs: update alerting docs (AlertManager) and add key rotation API#1680
docs: update alerting docs (AlertManager) and add key rotation API#1680OneStepAt4time merged 2 commits intodevelopfrom
Conversation
π Documentation Review: Critical Issues Foundπ΄ CRITICAL ERRORS - Must Fix Before Merge1. API Key Rotation Parameter MismatchProblem: Docs show incorrect parameter format
Current cURL example (WRONG): curl -X POST http://localhost:9100/v1/auth/keys/key-abc123/rotate \
-H "Authorization: Bearer $AEGIS_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{"expiresAt":"2025-12-31T23:59:59Z"}'Should be: curl -X POST http://localhost:9100/v1/auth/keys/key-abc123/rotate \
-H "Authorization: Bearer $AEGIS_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{"ttlDays": 365}'Code reference: 2. Alert Test Endpoint Request Body is IncorrectProblem: Documentation falsely claims test endpoint accepts
Current cURL example (WRONG): curl -X POST http://localhost:9100/v1/alerts/test \
-H "Authorization: Bearer $AEGIS_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{"webhookUrl":"https://example.com/alerts","secret":"test-secret"}'Should be: curl -X POST http://localhost:9100/v1/alerts/test \
-H "Authorization: Bearer $AEGIS_AUTH_TOKEN"Code reference: π‘ IMPORTANT GAPS - Should Fix3. Missing Authorization Requirements DocumentationAdd to AlertManager section:
Code reference: 4. Incomplete Alert Type CoverageCurrent docs list: session failures, dead sessions, tmux crashes Add to "AlertManager monitors" list:
Code reference: 5. Missing Environment Variable Configuration DetailsCurrent docs: "Configure via config.yaml or environment variables" Add documentation for: export AEGIS_ALERT_WEBHOOKS="https://example.com/alerts,https://backup.com/alerts"Or via config.yaml: alerting:
webhooks:
- https://example.com/alerts
failureThreshold: 5
cooldownMs: 600000β What's Correct
SummaryStatus: β Needs Changes
Requesting changes on:
|
β Documentation Issues FixedI've corrected all the issues identified in the review: Fixed (2 Critical Issues):
Added (3 Documentation Gaps):
Status: All corrections pushed to branch. PR now contains accurate, working documentation. Files modified:
|
- Fix API key rotation parameter from expiresAt (ISO timestamp) to ttlDays (integer) - Remove false request body parameters from /v1/alerts/test endpoint - Add authorization requirements for both alert endpoints - Add missing api_error_rate alert type to monitoring list - Add environment variable and config.yaml configuration examples - Format cURL examples with proper line breaks and comments
b0fa22c to
16e7622
Compare
β PR Rebased and Ready to MergeThe PR has been rebased onto the latest Status:
Commits on this PR:
What was fixed:
The PR is now mergeable and ready for approval. |
Summary
Updates docs for v0.5.0-alpha:
docs/enterprise.md β AlertManager
docs/api-reference.md β Key Rotation
Changes
Checklist
Aegis version: 0.5.0-alpha
Milestone: Documentation
Assignee: Scribe