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

API

Events

Data

Resilience

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

Decisions

  • Key decisions are recorded

    At least one architecture decision is written down and accepted, with its context and consequences.

    LowChecked automatically