Monitoring is how I keep a promise of reliability. Uptime checks, health endpoints, and alerting tell me an API is doing its job before consumers have to tell me it is not. Monitoring is the difference between finding out about an outage from a dashboard or from an angry customer.
Monitoring
Production
Stop 19
Policies at this stop
Communication Status Page
Every API must maintain a public status page that reports current health, active incidents, and scheduled maintenance in real time. I require that consumers be able to check the state of an API the...
Observability Is Instrumented
Every API must be instrumented for observability, exposing metrics, traces, and health signals that let operators understand its behavior in real time. I require that latency, error rates, and thro...
HTTP Status Codes (OpenAPI)
Require that every operation documents the HTTP status codes it can actually return, using the standard families the way the web intends, 2xx for success, 3xx for redirection, 4xx for consumer mist...
Health Checks (Operations)
Require that every API exposes a standard health check endpoint, so I want a predictable path that reports liveness and readiness along with the status of critical dependencies. I insist on this be...
Monitoring (Operations)
Require that every API is actively monitored for availability, latency, error rates, and traffic, so I want the golden signals collected, dashboarded, and wired to alerts before an API ever reaches...
Performance
Publishing details regarding the performance of APIs, complimenting status and uptime information, but drilling into more detail regarding speed, latency, and other performance related metrics that...
Status Dashboard
Require a link to as well as results from a status dashboard for an API.
Status History
Require a link to as well as results from a status history for an API.
Status
Making an API status page, monitoring reports, or other real-time updates regarding the uptime and availability of an API, providing current, but also the historical status of API, helping maintain...
