NFR & SLO
Purpose
Section titled “Purpose”Provide a structured place for non-functional requirements (NFRs) and service-level objectives (SLOs) for the Lee Kim ERP deployment. Numeric targets are contract- and environment-specific: fill them in workshops and store final numbers in your internal wiki or monitoring tool if they must not live in git.
This page extends the short template on Introduction — Overview with measurement and ownership columns. It does not replace live dashboards.
How to use this page
Section titled “How to use this page”- Copy the tables into your internal wiki or add org-approved numbers here in a fork/branch you are allowed to publish.
- Link evidence (dashboard URL, runbook entry) — use placeholders like
https://internal.example/monitoringin public docs. - Review at least annually or before major ERPNext upgrades.
Service availability
Section titled “Service availability”| Metric | Template / placeholder | Measurement | Owner | Review |
|---|---|---|---|---|
| Site availability SLO | e.g. 99.5% monthly (excluding planned maintenance) | Uptime probe or hosting SLA | Ops | Quarterly |
| Composite with SaaS | Xero / Stripe / DocuSign outages | Provider status pages + app Error Log | Ops + integrations | Per incident |
Third-party outages are often excluded from app SLOs unless the contract says otherwise — state the rule explicitly in the contract row.
Recovery (RPO / RTO)
Section titled “Recovery (RPO / RTO)”| Metric | Template / placeholder | Measurement | Owner |
|---|---|---|---|
| RPO (recovery point objective) | e.g. ≤ 24 h DB backup age | Backup job logs, restore drill | Ops |
| RTO (recovery time objective) | e.g. ≤ 4 h to restored Bench | Last restore test timestamp | Ops |
Tie to backup and restore procedures on Operational runbook and Deployment & operations.
Performance and latency
Section titled “Performance and latency”| Area | Typical concern | Where to look |
|---|---|---|
| User-facing Desk | Slow lists, long reports | MariaDB slow query log, Frappe frappe.monitor if enabled |
| Bulk payroll / billing | Table locks, long jobs | Off-peak scheduling; worker logs |
| Integration sync | Xero AR lag | Provider dashboards + app integration logs |
Document acceptable sync delay for finance integrations in the same workshop as commercial SLAs.
Security NFRs (summary)
Section titled “Security NFRs (summary)”| Topic | Pointer |
|---|---|
| Guest APIs and webhooks | Security checklist, Threat model |
| Secrets | Environment & integration matrix |
| Audit trail | Doc revision log, custom audit DocTypes — Architecture overview |
Observability
Section titled “Observability”| Source | Use |
|---|---|
| Frappe Error Log | Exceptions, failed hooks |
| Scheduler / worker logs | Cron, queue failures |
| Integration dashboards | Xero, Stripe, etc. |
This static site is not a monitoring tool — System context states the same.
Related
Section titled “Related”- Engineering deliverables hub
- Introduction — Overview — original NFR template table
- Release & compatibility