Production Readiness
Is this service ready for production traffic? Ownership, resilience, observability, security and deployment basics, checked against its design.
26 rules · 81% checked automatically
Check your service against it
Apply this checklist to a service described in MICROSERVICE.md™: 21 of its 26 rules are checked against the design automatically, and each failing rule points to where to fix it.
0 of 26 ticked · kept in this browser only
Ownership
- An owning team is named
One team owns the service end to end, and the design says which.
CriticalChecked automatically
- An on-call rotation or escalation contact is named
The design says who is reached, and how, when the service breaks outside office hours.
HighChecked automatically
- A runbook exists
The service has written steps for its most likely failures, so the person on call does not start from zero.
HighChecked automatically
API
- Every endpoint is described
Each REST endpoint says what it does, so callers and coding agents do not have to guess from the path.
MediumChecked automatically
- API paths carry a version
Every REST path includes a version segment, so a breaking change can ship next to the old contract.
MediumChecked automatically
- Create endpoints accept an idempotency key
A client can safely repeat a POST that creates something, because the server recognizes the repeat.
HighChecked by hand
Events
- Published events have a schema
Every event the service publishes has a declared payload, so consumers code against a contract and not against samples.
HighChecked automatically
- Published events name their broker and topic
Each published event says where it is published, so a consumer knows where to subscribe.
MediumChecked automatically
- Events are published through an outbox
A state change and the event that announces it are saved together, so one never happens without the other.
HighChecked by hand
- Event consumers handle duplicates
Every consumed event can arrive more than once; processing it twice must not change the outcome.
HighChecked by hand
Data
- The service owns its data and says what it holds
Each data store belongs to this service alone, and the design says what is kept in it.
HighChecked automatically
Resilience
- Hard dependencies have a timeout
Every synchronous call the service cannot work without has a declared timeout.
CriticalChecked automatically
- Hard dependencies have a circuit breaker or a fallback
When a dependency the service needs is failing, calls to it stop quickly or are answered another way.
HighChecked automatically
- Retries only on idempotent calls, with backoff and jitter
Retry a synchronous call only when repeating it is safe, and spread retries out so they don't pile onto a struggling dependency.
HighChecked by hand
Observability
- An availability objective is set
The service has a stated availability target, so "is it reliable enough?" has an answer.
HighChecked automatically
- A p99 latency target is set
The service states how fast its slowest normal requests should be.
MediumChecked automatically
- Distributed tracing is on
Requests carry a trace context through the service, so one request can be followed across services.
MediumChecked automatically
- Alerts are defined
The service has alerts on symptoms its users would notice, each one actionable.
HighChecked automatically
- A dashboard exists
The service has a dashboard showing its traffic, errors and latency at a glance.
LowChecked automatically
Security
- Every caller is authenticated
The design says how the service knows who is calling, for users and for other services.
CriticalChecked automatically
- Access is authorized per resource
The design says how the service decides what an authenticated caller may do, down to the individual resource.
HighChecked automatically
- Secrets live in a secret store
Credentials and keys are read from a secret manager at run time, never from the repository or plain configuration.
CriticalChecked automatically
- Personal data handling is documented
For the personal data it holds, the service states what it keeps, why, for how long and how it is erased.
HighChecked by hand
Deployment
- At least two replicas run
The service runs as two or more instances, so losing one does not take it down.
HighChecked automatically
- CPU and memory limits are set
Each instance declares how much CPU and memory it needs and may use.
MediumChecked automatically
Decisions
- Key decisions are recorded
At least one architecture decision is written down and accepted, with its context and consequences.
LowChecked automatically