@luanpdd/kit-mcp 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +86 -0
- package/README.md +58 -0
- package/gates/golden-signals-coverage.md +133 -0
- package/gates/postmortem-template-required.md +127 -0
- package/gates/prr-checklist-coverage.md +128 -0
- package/kit/agents/golden-signals-instrumenter.md +241 -0
- package/kit/agents/omm-auditor.md +52 -0
- package/kit/agents/postmortem-writer.md +282 -0
- package/kit/agents/prr-conductor.md +288 -0
- package/kit/agents/supabase-architect.md +49 -0
- package/kit/agents/supabase-edge-fn-writer.md +102 -0
- package/kit/agents/supabase-migration-writer.md +80 -0
- package/kit/agents/supabase-storage-implementer.md +156 -0
- package/kit/agents/toil-auditor.md +277 -0
- package/kit/commands/auditar-marco.md +81 -1
- package/kit/commands/auditar-toil.md +129 -0
- package/kit/commands/concluir-marco.md +55 -1
- package/kit/commands/forense.md +64 -1
- package/kit/commands/golden-signals.md +142 -0
- package/kit/commands/postmortem.md +179 -0
- package/kit/commands/prr.md +205 -0
- package/kit/commands/risk-budget.md +220 -0
- package/kit/commands/sre.md +227 -0
- package/kit/skills/_shared-sre/glossary.md +573 -0
- package/kit/skills/blameless-postmortems/SKILL.md +340 -0
- package/kit/skills/eliminating-toil/SKILL.md +243 -0
- package/kit/skills/event-based-slos/SKILL.md +22 -0
- package/kit/skills/four-golden-signals/SKILL.md +297 -0
- package/kit/skills/production-readiness-review/SKILL.md +305 -0
- package/kit/skills/sre-risk-management/SKILL.md +221 -0
- package/package.json +1 -1
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: four-golden-signals
|
|
3
|
+
description: Use ao instrumentar serviço user-facing — Latency + Traffic + Errors + Saturation, percentis (não mean), histogram exponencial, latência success vs error separadas.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# SRE — Four Golden Signals
|
|
7
|
+
|
|
8
|
+
## Quando usar
|
|
9
|
+
|
|
10
|
+
LLM carrega esta skill ao instrumentar Edge Function/serviço/microservice user-facing. Trigger phrases:
|
|
11
|
+
|
|
12
|
+
- "golden signals", "4 sinais dourados"
|
|
13
|
+
- "latency, traffic, errors, saturation"
|
|
14
|
+
- "instrumentar serviço", "métricas mínimas"
|
|
15
|
+
- "p99 latency", "percentis vs mean"
|
|
16
|
+
- "black-box vs white-box monitoring"
|
|
17
|
+
- "Google SRE cap 6"
|
|
18
|
+
- "Latency success vs error"
|
|
19
|
+
|
|
20
|
+
## Regras absolutas
|
|
21
|
+
|
|
22
|
+
- **4 sinais são universais para serviço user-facing** — Latency + Traffic + Errors + Saturation. Se mede esses 4, captura ~95% da saúde operacional. Outros sinais (CPU, memória, disco I/O) são **causas potenciais**, não sintomas — vão em white-box monitoring secundário.
|
|
23
|
+
- **Latency success vs error sempre separadas** — falhas rápidas (HTTP 500 em 5ms) mascaram latência ruim de successes se misturadas. Sempre `histogram(duration_ms, {result: 'success'})` e `histogram(duration_ms, {result: 'error'})` em séries distintas.
|
|
24
|
+
- **NUNCA mean para latency** — long tail invisível: mean=50ms mas p99=5000ms é UX ruim para 1% dos usuários (tipicamente os mais valiosos: enterprise tier). SEMPRE histogram com percentis.
|
|
25
|
+
- **Histogram com bucketing exponencial** — buckets `[1, 2, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 30000]` ms ou base 1.5/2. Captura long tail sem cardinality explosion.
|
|
26
|
+
- **Errors counter por error.type (não message)** — `error.type` enumerado (5-15 valores: `timeout`, `validation`, `auth`, `rate_limit`, `db`, `provider_down`, ...). `error.message` é alta cardinalidade — não usar como dimension.
|
|
27
|
+
- **Saturation é resource-specific** — não existe métrica genérica de saturação. Para HTTP service: connection pool used %. Para DB: tablespace used %. Para queue: queue depth. Para CPU-bound: load average. Identificar O recurso mais escasso ANTES de instrumentar.
|
|
28
|
+
- **Black-box monitora UX, white-box monitora internals** — black-box (synthetic prober HTTP) detecta "site offline" mesmo se métricas internas estão verdes (corner case clássico). White-box (golden signals) explica "porquê" quando black-box dispara.
|
|
29
|
+
- **Reportar p50, p95, p99, p99.9 — não só p99** — p50 (mediana) é UX típica; p95 é primeiro deslize; p99 é cauda; p99.9 é seu 1 em 1000 que é seu cliente enterprise. Cada percentil conta uma história diferente.
|
|
30
|
+
|
|
31
|
+
## Patterns canônicos
|
|
32
|
+
|
|
33
|
+
### Pattern: definição canônica dos 4 signals (tabela)
|
|
34
|
+
|
|
35
|
+
| Signal | Definição | Tipo de instrument | Granularity recomendada |
|
|
36
|
+
|---|---|---|---|
|
|
37
|
+
| **Latency** | Tempo de request bem-sucedido vs falho — SEPARADO | Histogram (ms) com bucketing exponencial | Por endpoint × `result` (success/error) |
|
|
38
|
+
| **Traffic** | Volume de demanda — requests/s, msgs/s, bytes/s | Counter | Por endpoint × method |
|
|
39
|
+
| **Errors** | Taxa de requests que falharam (explícitas: 5xx; implícitas: 200 com payload errado; políticas: > SLO target) | Counter | Por endpoint × `error.type` |
|
|
40
|
+
| **Saturation** | "Quão cheio" o serviço está — % do recurso mais escasso | ObservableGauge (%) | Por resource (connection pool, queue, CPU) |
|
|
41
|
+
|
|
42
|
+
### Pattern: instrumentação canônica em OTel SDK (TypeScript/Deno)
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
// PT-BR: 4 golden signals em Edge Function — copiar este shape
|
|
46
|
+
import { trace, metrics } from '@opentelemetry/api'
|
|
47
|
+
|
|
48
|
+
const tracer = trace.getTracer('orders-service')
|
|
49
|
+
const meter = metrics.getMeter('orders-service')
|
|
50
|
+
|
|
51
|
+
// PT-BR: 1. LATENCY — histogram bucketed exponencial
|
|
52
|
+
const latencyHistogram = meter.createHistogram('http_request_duration_ms', {
|
|
53
|
+
description: 'Request latency in ms — split by result',
|
|
54
|
+
unit: 'ms',
|
|
55
|
+
advice: { explicitBucketBoundaries: [1, 2, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 30000] }
|
|
56
|
+
})
|
|
57
|
+
|
|
58
|
+
// PT-BR: 2. TRAFFIC — counter de requests recebidos
|
|
59
|
+
const trafficCounter = meter.createCounter('http_requests_total', {
|
|
60
|
+
description: 'Total HTTP requests received'
|
|
61
|
+
})
|
|
62
|
+
|
|
63
|
+
// PT-BR: 3. ERRORS — counter por error.type (categoria, não message)
|
|
64
|
+
const errorsCounter = meter.createCounter('http_errors_total', {
|
|
65
|
+
description: 'Total HTTP errors by error.type'
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
// PT-BR: 4. SATURATION — gauge do recurso mais escasso
|
|
69
|
+
const saturationGauge = meter.createObservableGauge('db_connection_pool_used_pct', {
|
|
70
|
+
description: 'DB connection pool utilization %',
|
|
71
|
+
unit: '%'
|
|
72
|
+
})
|
|
73
|
+
saturationGauge.addCallback((result) => {
|
|
74
|
+
// PT-BR: callback executado em scrape — lê estado atual do pool
|
|
75
|
+
result.observe(getConnectionPoolUsedPct(), { resource: 'db_pool', service: 'orders' })
|
|
76
|
+
})
|
|
77
|
+
|
|
78
|
+
export async function placeOrder(req: Request) {
|
|
79
|
+
const startMs = performance.now()
|
|
80
|
+
const dims = { endpoint: '/api/v1/orders', method: 'POST' }
|
|
81
|
+
|
|
82
|
+
// PT-BR: 2. Traffic — incrementar antes de processar
|
|
83
|
+
trafficCounter.add(1, dims)
|
|
84
|
+
|
|
85
|
+
return tracer.startActiveSpan('place_order', async (span) => {
|
|
86
|
+
try {
|
|
87
|
+
const order = await db.insertOrder(req.body)
|
|
88
|
+
// PT-BR: 1. Latency success — só após success confirmar
|
|
89
|
+
const durationMs = performance.now() - startMs
|
|
90
|
+
latencyHistogram.record(durationMs, { ...dims, result: 'success' })
|
|
91
|
+
return order
|
|
92
|
+
} catch (e) {
|
|
93
|
+
// PT-BR: 1. Latency error — separada da success
|
|
94
|
+
const durationMs = performance.now() - startMs
|
|
95
|
+
latencyHistogram.record(durationMs, { ...dims, result: 'error' })
|
|
96
|
+
// PT-BR: 3. Errors — counter por error.type (enum baixa cardinalidade)
|
|
97
|
+
errorsCounter.add(1, { ...dims, error_type: classify(e) })
|
|
98
|
+
throw e
|
|
99
|
+
} finally {
|
|
100
|
+
span.end()
|
|
101
|
+
}
|
|
102
|
+
})
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// PT-BR: classifier — enum estável de 5-15 valores
|
|
106
|
+
function classify(e: unknown): string {
|
|
107
|
+
if (e instanceof TimeoutError) return 'timeout'
|
|
108
|
+
if (e instanceof ValidationError) return 'validation'
|
|
109
|
+
if (e instanceof AuthError) return 'auth'
|
|
110
|
+
if (e instanceof RateLimitError) return 'rate_limit'
|
|
111
|
+
if (e instanceof DbError) return 'db'
|
|
112
|
+
return 'unknown'
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Pattern: queries SQL para 4 signals em 1 dashboard
|
|
117
|
+
|
|
118
|
+
```sql
|
|
119
|
+
-- PT-BR: dashboard único — 4 golden signals últimos 60 minutos, por minuto
|
|
120
|
+
select
|
|
121
|
+
date_trunc('minute', timestamp) as minute,
|
|
122
|
+
-- Traffic
|
|
123
|
+
count(*) as traffic_rpm,
|
|
124
|
+
-- Errors (por error.type)
|
|
125
|
+
count(*) filter (where result_success = false) as errors_total,
|
|
126
|
+
count(*) filter (where error_type = 'timeout') as errors_timeout,
|
|
127
|
+
count(*) filter (where error_type = 'rate_limit') as errors_rate_limit,
|
|
128
|
+
count(*) filter (where error_type = 'db') as errors_db,
|
|
129
|
+
-- Latency p50/p95/p99 — APENAS success
|
|
130
|
+
percentile_cont(0.50) within group (order by duration_ms)
|
|
131
|
+
filter (where result_success = true) as latency_p50_success,
|
|
132
|
+
percentile_cont(0.95) within group (order by duration_ms)
|
|
133
|
+
filter (where result_success = true) as latency_p95_success,
|
|
134
|
+
percentile_cont(0.99) within group (order by duration_ms)
|
|
135
|
+
filter (where result_success = true) as latency_p99_success,
|
|
136
|
+
-- Latency p99 — APENAS error (visibilidade de error path lentidão)
|
|
137
|
+
percentile_cont(0.99) within group (order by duration_ms)
|
|
138
|
+
filter (where result_success = false) as latency_p99_error,
|
|
139
|
+
-- Saturation (gauge max no minuto)
|
|
140
|
+
max(connection_pool_used_pct) as saturation_pool_max
|
|
141
|
+
from observability.events
|
|
142
|
+
where service = 'orders-api' and timestamp > now() - interval '60 minutes'
|
|
143
|
+
group by minute
|
|
144
|
+
order by minute desc;
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Pattern: black-box probe complementar (synthetic check)
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
// PT-BR: black-box monitoring — chamar serviço como cliente externo
|
|
151
|
+
// Roda em CI ou serviço external (uptimerobot, datadog synthetics)
|
|
152
|
+
async function blackBoxProbe(): Promise<{ ok: boolean; durationMs: number }> {
|
|
153
|
+
const startMs = Date.now()
|
|
154
|
+
const r = await fetch('https://api.example.com/api/v1/orders/probe', {
|
|
155
|
+
method: 'POST',
|
|
156
|
+
body: JSON.stringify({ probe: true, sku: 'TEST-001' }),
|
|
157
|
+
headers: { 'X-Probe': 'true' }
|
|
158
|
+
})
|
|
159
|
+
const durationMs = Date.now() - startMs
|
|
160
|
+
// PT-BR: validar resposta — não basta status 200
|
|
161
|
+
const body = await r.json()
|
|
162
|
+
const ok = r.status === 200 && body.order_id != null && durationMs < 1000
|
|
163
|
+
return { ok, durationMs }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// PT-BR: rodar a cada 30s; alerta se 3 consecutivos falham (debounce contra flake)
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Pattern: saturation por tipo de serviço
|
|
170
|
+
|
|
171
|
+
| Tipo de serviço | Recurso mais escasso | Métrica de saturation |
|
|
172
|
+
|---|---|---|
|
|
173
|
+
| HTTP API stateless | Connection pool DB | `db_connection_pool_used_pct` |
|
|
174
|
+
| API com cache | Memory do cache | `cache_memory_used_pct` |
|
|
175
|
+
| Worker async | Queue depth | `queue_depth_messages` |
|
|
176
|
+
| Edge Function | Concurrency limit Deno | `concurrent_executions_pct` |
|
|
177
|
+
| DB | Tablespace ou WAL | `disk_used_pct`, `wal_lag_bytes` |
|
|
178
|
+
| CPU-bound (encoder, ML) | Load average | `cpu_load_avg_5min` |
|
|
179
|
+
| Network egress | Bandwidth | `egress_bytes_per_sec_pct` |
|
|
180
|
+
|
|
181
|
+
## Anti-patterns
|
|
182
|
+
|
|
183
|
+
### ANTI: mean latency
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
ANTI: alerta/dashboard com avg(duration_ms) — long tail invisível.
|
|
187
|
+
|
|
188
|
+
PROBLEMA: mean=50ms mas p99=5000ms = UX ruim invisível; cliente enterprise
|
|
189
|
+
(no p99) sofre sem nunca disparar alerta. Mean é puxado para baixo
|
|
190
|
+
por mass de requests rápidos; sinaliza "tudo ok" enquanto 1% dos
|
|
191
|
+
users espera 5s.
|
|
192
|
+
|
|
193
|
+
CERTO: histogram com percentile_cont(0.99); alertar em p99 > target.
|
|
194
|
+
Reportar p50/p95/p99/p99.9 para ver formato da distribuição.
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### ANTI: latência success+error misturadas
|
|
198
|
+
|
|
199
|
+
```text
|
|
200
|
+
ANTI: histogram(duration_ms) sem dimension result.
|
|
201
|
+
|
|
202
|
+
PROBLEMA: falhas rápidas (HTTP 500 em 5ms quando timeout dispara cedo)
|
|
203
|
+
puxam mean/percentis para baixo; mascaram lentidão real de
|
|
204
|
+
requests bem-sucedidos. Dashboard mostra "p99=80ms" mas
|
|
205
|
+
successes reais são 800ms.
|
|
206
|
+
|
|
207
|
+
CERTO: dimension {result: 'success'} vs {result: 'error'} SEMPRE separadas
|
|
208
|
+
em séries distintas. SLI/SLO computado APENAS sobre success path.
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### ANTI: Errors com error.message como dimension
|
|
212
|
+
|
|
213
|
+
```text
|
|
214
|
+
ANTI: errorsCounter.add(1, { error_message: e.message })
|
|
215
|
+
|
|
216
|
+
PROBLEMA: cada mensagem única é uma série temporal; cardinality explosion
|
|
217
|
+
(1M+ séries em horas se message contém timestamps/IDs/random);
|
|
218
|
+
time-series DB OOMs ou throttles; queries lentas/impossíveis;
|
|
219
|
+
custo de armazenamento explode.
|
|
220
|
+
|
|
221
|
+
CERTO: enum error.type com 5-15 valores fixos (timeout, validation, auth,
|
|
222
|
+
rate_limit, db, provider_down, unknown); error.message em
|
|
223
|
+
log/span attribute (não métrica) para debug pontual.
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### ANTI: monitoring causes não symptoms
|
|
227
|
+
|
|
228
|
+
```text
|
|
229
|
+
ANTI: alertar em "CPU > 80% / memory < 10% / threads > N"
|
|
230
|
+
|
|
231
|
+
PROBLEMA: mistura "what" (sintoma user-facing) com "why" (causa interna);
|
|
232
|
+
falsos positivos (cron job legítimo dispara CPU);
|
|
233
|
+
falsos negativos (sistema lento sem CPU alta — saturação em
|
|
234
|
+
connection pool ou rede); on-call paginado por nada e
|
|
235
|
+
incidents reais passam silenciosos.
|
|
236
|
+
|
|
237
|
+
CERTO: alertar em SLO burn rate sobre os 4 signals (event-based,
|
|
238
|
+
customer-impacting); usar CPU/memory como debug context em
|
|
239
|
+
white-box monitoring, não como alert source.
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### ANTI: saturation genérica
|
|
243
|
+
|
|
244
|
+
```text
|
|
245
|
+
ANTI: copiar pattern de saturation de outro serviço sem identificar o
|
|
246
|
+
gargalo real.
|
|
247
|
+
|
|
248
|
+
PROBLEMA: mede CPU em serviço onde gargalo é connection pool; mede memory
|
|
249
|
+
em serviço CPU-bound; saturation alerta nunca dispara antes do
|
|
250
|
+
incident; quando incident acontece, dashboard mostra "saturação
|
|
251
|
+
OK" e ninguém sabe explicar por quê.
|
|
252
|
+
|
|
253
|
+
CERTO: identificar EXPLICITAMENTE o recurso mais escasso (DB pool? queue
|
|
254
|
+
depth? Deno concurrency? tablespace?) ANTES de instrumentar (ver
|
|
255
|
+
Pattern: saturation por tipo de serviço). Cada serviço tem 1 ou 2
|
|
256
|
+
gargalos reais — instrumentar esses, não copiar template.
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### ANTI: black-box only (sem white-box)
|
|
260
|
+
|
|
261
|
+
```text
|
|
262
|
+
ANTI: só prober externo (synthetic check), sem instrumentação interna.
|
|
263
|
+
|
|
264
|
+
PROBLEMA: sabe que "site offline" mas não sabe porquê; debug requer SSH
|
|
265
|
+
em prod / log dive sem instrumentation; MTTR cresce horas;
|
|
266
|
+
incidents repetem porque root cause nunca foi capturada.
|
|
267
|
+
|
|
268
|
+
CERTO: black-box detecta UX impact (cliente real não consegue) + white-box
|
|
269
|
+
(4 signals) explica root cause. Os dois juntos: black-box dispara,
|
|
270
|
+
white-box mostra qual signal degradou (latency? errors? saturation?)
|
|
271
|
+
e em qual endpoint.
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
## Verificação
|
|
275
|
+
|
|
276
|
+
Antes de marcar instrumentação como production-ready, validar:
|
|
277
|
+
|
|
278
|
+
1. **Os 4 signals presentes** — Latency (histogram), Traffic (counter), Errors (counter por error.type), Saturation (gauge resource-specific)
|
|
279
|
+
2. **Latency separada** — `result: 'success'` e `result: 'error'` em séries distintas
|
|
280
|
+
3. **Histogram com bucketing exponencial** — não fixed buckets lineares
|
|
281
|
+
4. **error.type é enum (5-15 valores)** — não `error.message` como dimension
|
|
282
|
+
5. **Saturation tem o recurso certo identificado** — connection pool? queue depth? concurrency? CPU load?
|
|
283
|
+
6. **Black-box probe complementar** — synthetic check do happy path principal a cada 30s
|
|
284
|
+
7. **Dashboard de 4 signals** existe e é o **primeiro** lugar de debug em incident
|
|
285
|
+
|
|
286
|
+
## Ver também
|
|
287
|
+
|
|
288
|
+
- [`_shared-sre/glossary.md`](../_shared-sre/glossary.md) — termos canônicos golden signals, black-box, white-box, percentile
|
|
289
|
+
- [`opentelemetry-standard`](../opentelemetry-standard/SKILL.md) (v1.9) — OTel SDK base, exporter, OTLP
|
|
290
|
+
- [`structured-events`](../structured-events/SKILL.md) (v1.9) — wide events que alimentam SLI de Errors
|
|
291
|
+
- [`event-based-slos`](../event-based-slos/SKILL.md) (v1.9) — SLO sobre Errors+Latency forma SLI canônico
|
|
292
|
+
- [`burn-rate-alerting`](../burn-rate-alerting/SKILL.md) (v1.9) — alertar em SLO burn-rate, não em CPU
|
|
293
|
+
- [`production-readiness-review`](../production-readiness-review/SKILL.md) — PRR axis "Instrumentation" exige 4 signals
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
*Material-fonte: Site Reliability Engineering — Beyer, Jones, Petoff, Murphy (Google/O'Reilly, 2016) — Cap 6: "Monitoring Distributed Systems" (Four Golden Signals).*
|
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: production-readiness-review
|
|
3
|
+
description: Use antes de aceitar serviço em produção — PRR checklist 6 axes (System/Instrumentation/Emergency/Capacity/Change/Performance), 3 engagement models, handoff dev→SRE.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# SRE — Production Readiness Review (PRR)
|
|
7
|
+
|
|
8
|
+
## Quando usar
|
|
9
|
+
|
|
10
|
+
LLM carrega esta skill ao avaliar serviço/feature antes de produção, conduzir handoff dev→SRE, ou definir engagement model. Trigger phrases:
|
|
11
|
+
|
|
12
|
+
- "PRR", "production readiness review"
|
|
13
|
+
- "production-bound", "ready for prod"
|
|
14
|
+
- "handoff dev to SRE"
|
|
15
|
+
- "engagement model", "early engagement"
|
|
16
|
+
- "SRE platform", "frameworks readiness"
|
|
17
|
+
- "Google SRE cap 32"
|
|
18
|
+
- "system architecture / instrumentation / emergency response / capacity / change / performance"
|
|
19
|
+
|
|
20
|
+
## Regras absolutas
|
|
21
|
+
|
|
22
|
+
- **PRR é GATE, não recomendação** — feature/serviço sem PRR aprovado NÃO entra em produção real (apenas dogfooding/staging). Sem gate, "production-ready" vira slogan; com gate, vira invariante.
|
|
23
|
+
- **6 axes obrigatórios** — System Architecture, Instrumentation/Metrics/Monitoring, Emergency Response, Capacity Planning, Change Management, Performance. Pular um axe = aprovação inválida (lacuna oculta vira incident em 6 meses).
|
|
24
|
+
- **3 engagement models — escolher conforme custo do serviço** — Simple PRR (serviços pequenos/internal), Early Engagement (serviços críticos), Frameworks/SRE Platform (serviços built on top of platform). Modelo errado = ou over-investment (Simple para tier-1) ou under-investment (Early para internal tool).
|
|
25
|
+
- **PRR é ANTES, não DEPOIS** — não "deploy primeiro, fazer PRR depois". PRR conclusão é pré-requisito de aceitar tráfego real (≥ 1% de usuários).
|
|
26
|
+
- **PRR é EVIDENCE-BASED, não opinião** — cada item do checklist tem critério verificável (load test report, runbook URL, dashboard link). "Acreditamos que está pronto" ≠ PRR aprovado.
|
|
27
|
+
- **Action items P0 = blocker; P1 = scheduled** — gaps P0 (sem instrumentação básica, sem rollback, sem on-call) bloqueiam aprovação. Gaps P1 (otimização capacidade, runbook adicional) viram tasks com due date — não bloqueiam, mas são tracked.
|
|
28
|
+
- **Reviewer ≠ time dev** — PRR conduzido por SRE ou par externo ao time dev (eyes-on-code novos, viés reduzido). Auto-PRR pelo time dev = oversight.
|
|
29
|
+
- **PRR é vivo, não one-shot** — após mudança maior (rewrite, novo dependency, RPS 10×), re-run PRR. Statement "passou PRR uma vez em 2024" não é evidence em 2026.
|
|
30
|
+
|
|
31
|
+
## Patterns canônicos
|
|
32
|
+
|
|
33
|
+
### Pattern: checklist canônico PRR — 6 axes detalhados
|
|
34
|
+
|
|
35
|
+
````markdown
|
|
36
|
+
```markdown
|
|
37
|
+
# PRR Checklist — <serviço/feature> — <data>
|
|
38
|
+
|
|
39
|
+
Reviewer: @<sre-or-external>
|
|
40
|
+
Status: Draft | In Review | Approved | Blocked
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Axe 1: System Architecture
|
|
45
|
+
|
|
46
|
+
- [ ] **Redundância**: serviço tolera falha de N instâncias (N=1 mínimo, N=2 ideal). Evidence: deployment manifest (replicas: 2+).
|
|
47
|
+
- [ ] **Single point of failure mapeado**: SPOFs documentados; mitigation plan claro. Evidence: arch diagram + SPOF list.
|
|
48
|
+
- [ ] **Failure modes mapeados**: top 5 modos de falha conhecidos com impact + mitigation. Evidence: failure mode analysis doc.
|
|
49
|
+
- [ ] **Load balancing strategy**: round-robin / least-conn / consistent-hash documentado. Evidence: LB config.
|
|
50
|
+
- [ ] **Graceful degradation**: serviço degrada (não crasha) sob carga ou dependency failure. Evidence: chaos test report ou load test config.
|
|
51
|
+
|
|
52
|
+
## Axe 2: Instrumentation, Metrics, Monitoring
|
|
53
|
+
|
|
54
|
+
- [ ] **4 golden signals presentes**: Latency (histogram), Traffic (counter), Errors (counter por error.type), Saturation (gauge). Evidence: dashboard URL + queries.
|
|
55
|
+
- [ ] **SLI/SLO definidos**: ao menos 1 SLO por jornada crítica do user (ver [event-based-slos](../event-based-slos/SKILL.md)). Evidence: SLO.md em `.planning/slos/`.
|
|
56
|
+
- [ ] **Alertas SLO burn-rate**: NÃO threshold em CPU/mem/etc. Evidence: alert rules em código + correlação com SLO definido.
|
|
57
|
+
- [ ] **Logs estruturados**: wide events com campos canônicos (`user.id`, `request.id`, `error.type`, `result.success`, `duration_ms`, `build_id`). Evidence: log query exemplo.
|
|
58
|
+
- [ ] **Traces propagados**: W3C TraceContext header em hops cross-service. Evidence: trace exemplo cross-service.
|
|
59
|
+
|
|
60
|
+
## Axe 3: Emergency Response
|
|
61
|
+
|
|
62
|
+
- [ ] **Runbook existe e foi testado**: passos para incident comuns (5+ scenarios). Evidence: URL do runbook + log do último teste.
|
|
63
|
+
- [ ] **On-call rotation definida**: schedule visível, ≥ 2 pessoas, escalation policy. Evidence: PagerDuty/Opsgenie schedule.
|
|
64
|
+
- [ ] **Page routing**: alertas SLO → on-call específico (não generic). Evidence: alert routing rules.
|
|
65
|
+
- [ ] **Escalation policy**: timeline clara (page → 5 min ack → 15 min escalate to L2 → 30 min L3). Evidence: doc.
|
|
66
|
+
- [ ] **Wheel of Misfortune realizado nos últimos 90d**: time praticou response em incident histórico. Evidence: data + participantes.
|
|
67
|
+
|
|
68
|
+
## Axe 4: Capacity Planning
|
|
69
|
+
|
|
70
|
+
- [ ] **Load test executado**: pico esperado × 2 testado; report com latency degradation curve. Evidence: load test report.
|
|
71
|
+
- [ ] **RPS limit documentado**: serviço sabe seu max sustainable RPS por instance. Evidence: number + source.
|
|
72
|
+
- [ ] **Auto-scaling testado**: scale-up + scale-down funcionam sem intervenção manual. Evidence: scaling test log.
|
|
73
|
+
- [ ] **Quota/rate-limit por tenant**: tenant abusivo não derruba serviço para outros. Evidence: rate-limit config.
|
|
74
|
+
- [ ] **Headroom ≥ 30%**: capacidade atual / pico esperado ≥ 1.3. Evidence: cálculo + dashboard.
|
|
75
|
+
|
|
76
|
+
## Axe 5: Change Management
|
|
77
|
+
|
|
78
|
+
- [ ] **Canary release**: deploys vão para 1% → 10% → 100% com hold em cada estágio. Evidence: CI pipeline config.
|
|
79
|
+
- [ ] **Feature flags**: features novas atrás de flag (deploy ≠ release). Evidence: feature flag service.
|
|
80
|
+
- [ ] **Rollback automatizado**: SLO burn rate > N nos primeiros M min após deploy → rollback automático. Evidence: rollback automation config.
|
|
81
|
+
- [ ] **CI/CD gates obrigatórios**: testes + lint + security scan + load test (em paths críticos). Evidence: CI config.
|
|
82
|
+
- [ ] **Deploy frequency mensurado**: time conhece sua deploy cadence (commits/dia ou /semana). Evidence: metric URL.
|
|
83
|
+
|
|
84
|
+
## Axe 6: Performance
|
|
85
|
+
|
|
86
|
+
- [ ] **Latency baseline (p50/p95/p99/p99.9)**: número conhecido para cada percentil principal. Evidence: dashboard query.
|
|
87
|
+
- [ ] **Error budget definido**: SLO target × window definidos; budget calculado. Evidence: SLO.md.
|
|
88
|
+
- [ ] **Saturation tracked**: CPU / memory / connection pool / queue depth — recurso mais escasso identificado. Evidence: gauge query.
|
|
89
|
+
- [ ] **Long tail (p99.9) monitored**: não só p50; alerta se p99.9 > N×p50 (regression detection). Evidence: query.
|
|
90
|
+
- [ ] **Risk continuum justificado**: target SLO escolhido com base em risk × innovation, não default 99.99%. Evidence: justificativa em SLO.md (ver [sre-risk-management](../sre-risk-management/SKILL.md)).
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Action Items
|
|
95
|
+
|
|
96
|
+
| # | Axe | Item | Severity | Owner | Due |
|
|
97
|
+
|---|-----|------|----------|-------|-----|
|
|
98
|
+
| 1 | 2 | Adicionar saturation gauge em /api/v1/orders | P0 | @bob | 2026-05-15 |
|
|
99
|
+
| 2 | 4 | Documentar RPS limit em runbook | P1 | @alice | 2026-05-22 |
|
|
100
|
+
|
|
101
|
+
## Decisão
|
|
102
|
+
|
|
103
|
+
- [x] **Approved** — service production-ready
|
|
104
|
+
- [ ] **Approved with conditions** — P1s tracked, P0s blockers em release próximo
|
|
105
|
+
- [ ] **Blocked** — P0 gaps; service NÃO aceita tráfego real até resolução
|
|
106
|
+
|
|
107
|
+
## Reviewer signature
|
|
108
|
+
|
|
109
|
+
Reviewer: @<sre>
|
|
110
|
+
Date: YYYY-MM-DD
|
|
111
|
+
```
|
|
112
|
+
````
|
|
113
|
+
|
|
114
|
+
### Pattern: 3 engagement models — quando usar cada
|
|
115
|
+
|
|
116
|
+
| Modelo | Quando usar | SRE involvement | Custo SRE |
|
|
117
|
+
|---|---|---|---|
|
|
118
|
+
| **Simple PRR** | Serviços pequenos, internal tools, dogfood-only | Reviewer 1 sessão; checklist preenchido por dev | Baixo (4-8h) |
|
|
119
|
+
| **Early Engagement** | Serviços críticos (tier-1), customer-facing, expected RPS > 1k/s | SRE participa do design; junior review em milestones; full PRR pré-launch | Médio (semanas) |
|
|
120
|
+
| **Frameworks / SRE Platform** | Serviços built on top of plataforma SRE-blessed (lib + templates + gates já PRR-ready) | SRE manteve plataforma; dev usa scaffolds; PRR é confirmação que dev seguiu plataforma | Baixo recorrente, alto setup inicial |
|
|
121
|
+
|
|
122
|
+
Modelo escolhido pelo **custo de outage** do serviço:
|
|
123
|
+
|
|
124
|
+
- Outage < $1k/min → Simple PRR (1 sessão, checklist)
|
|
125
|
+
- Outage $1k-100k/min → Early Engagement (SRE no design)
|
|
126
|
+
- Outage > $100k/min OR > 10 microserviços similares → Platform (libs/scaffolds eliminam toil de PRR)
|
|
127
|
+
|
|
128
|
+
### Pattern: handoff dev → SRE — sequência canônica
|
|
129
|
+
|
|
130
|
+
```text
|
|
131
|
+
1. Dev declara intenção: "Esse serviço vai produção em 2026-MM-DD."
|
|
132
|
+
2. Reviewer SRE aceita engagement model (Simple/Early/Platform).
|
|
133
|
+
3. Dev preenche PRR checklist (6 axes) com evidence em cada item.
|
|
134
|
+
4. Reviewer abre PRR-REPORT.md em .planning/prr/<service>.md, score cada axe (Pass/Fail/N-A).
|
|
135
|
+
5. Reviewer + dev discutem gaps:
|
|
136
|
+
- P0 (blocker): dev resolve antes de production ship
|
|
137
|
+
- P1 (scheduled): owner + due date; tracked em roadmap
|
|
138
|
+
- P2 (optional): documentado mas não obrigatório
|
|
139
|
+
6. Após P0s resolvidos, reviewer marca Approved e assina.
|
|
140
|
+
7. Dev ship (canary 1% → 100%).
|
|
141
|
+
8. Pós-launch: SRE review SLO compliance em 7d, 30d, 90d.
|
|
142
|
+
9. Re-PRR triggered em mudanças maiores (rewrite, RPS 10×, novo dependency tier-1).
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Pattern: SRE Platform como amplificador
|
|
146
|
+
|
|
147
|
+
```text
|
|
148
|
+
Plataforma SRE consiste em:
|
|
149
|
+
|
|
150
|
+
1. Library/SDK que codifica boas práticas (otel-by-default, structured-logging-by-default,
|
|
151
|
+
4-golden-signals-by-default, rate-limit-by-default, circuit-breaker-by-default)
|
|
152
|
+
2. Scaffolds/templates de novo serviço (kit-mcp 's `/sre`, e.g., `/sre new-service <name>`)
|
|
153
|
+
3. CI gates que verificam adequação à plataforma (gates de Phase 41:
|
|
154
|
+
golden-signals-coverage, postmortem-template-required, prr-checklist-coverage)
|
|
155
|
+
4. Runbook templates por categoria de serviço (HTTP API, async worker, batch job)
|
|
156
|
+
|
|
157
|
+
Resultado: novo serviço nasce com 80% do PRR já passado por design.
|
|
158
|
+
PRR vira confirmação ("você usou a plataforma?"), não auditoria de zero.
|
|
159
|
+
|
|
160
|
+
Trade-off: setup inicial alto (semanas-meses para escrever plataforma).
|
|
161
|
+
Recomendado para org com 10+ microserviços similares.
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Pattern: PRR-REPORT.md template canônico
|
|
165
|
+
|
|
166
|
+
````markdown
|
|
167
|
+
```markdown
|
|
168
|
+
# PRR-REPORT — <serviço/feature> — <data>
|
|
169
|
+
|
|
170
|
+
**Reviewer:** @<sre-or-external>
|
|
171
|
+
**Engagement model:** Simple PRR | Early Engagement | Frameworks/Platform
|
|
172
|
+
**Status:** Approved | Approved with conditions | Blocked
|
|
173
|
+
|
|
174
|
+
## Sumário executivo
|
|
175
|
+
|
|
176
|
+
Resultado por axe (1-2 linhas cada):
|
|
177
|
+
|
|
178
|
+
| Axe | Score | Status |
|
|
179
|
+
|-----|-------|--------|
|
|
180
|
+
| 1. System Architecture | 5/5 | Pass |
|
|
181
|
+
| 2. Instrumentation, Metrics, Monitoring | 4/5 | Pass with gaps |
|
|
182
|
+
| 3. Emergency Response | 3/5 | Fail (P0) |
|
|
183
|
+
| 4. Capacity Planning | 4/5 | Pass with gaps |
|
|
184
|
+
| 5. Change Management | 5/5 | Pass |
|
|
185
|
+
| 6. Performance | 4/5 | Pass with gaps |
|
|
186
|
+
|
|
187
|
+
## Detalhamento por axe
|
|
188
|
+
|
|
189
|
+
[seção por axe com itens checked + evidence + gaps]
|
|
190
|
+
|
|
191
|
+
## Action Items
|
|
192
|
+
|
|
193
|
+
[tabela com P0/P1/P2 + owner + due]
|
|
194
|
+
|
|
195
|
+
## Aprovação
|
|
196
|
+
|
|
197
|
+
[Approved / Approved with conditions / Blocked]
|
|
198
|
+
[Assinatura + data]
|
|
199
|
+
```
|
|
200
|
+
````
|
|
201
|
+
|
|
202
|
+
## Anti-patterns
|
|
203
|
+
|
|
204
|
+
### ANTI: PRR depois do launch
|
|
205
|
+
|
|
206
|
+
```text
|
|
207
|
+
ANTI: fazer PRR após serviço já em produção.
|
|
208
|
+
|
|
209
|
+
PROBLEMA: gaps P0 já causaram incidents (sem instrumentação significa SEV1 cego);
|
|
210
|
+
valor de gate perdido; PRR vira post-mortem disfarçado.
|
|
211
|
+
|
|
212
|
+
CERTO: PRR ANTES de aceitar tráfego real (≥ 1%); blocker se P0 pendente.
|
|
213
|
+
PRR conclusão é pré-requisito de aceitar tráfego, não follow-up.
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### ANTI: auto-PRR pelo time dev
|
|
217
|
+
|
|
218
|
+
```text
|
|
219
|
+
ANTI: time dev preenche checklist + auto-aprova.
|
|
220
|
+
|
|
221
|
+
PROBLEMA: confirmation bias (dev acredita que serviço é maduro); itens vagos
|
|
222
|
+
passam ("Sim, temos monitoring"); gaps invisíveis até incident.
|
|
223
|
+
|
|
224
|
+
CERTO: reviewer EXTERNO ao time (SRE ou outro time dev sênior); evidence-based
|
|
225
|
+
em cada item; dev preenche, externo verifica.
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### ANTI: pular axes "menos relevantes"
|
|
229
|
+
|
|
230
|
+
```text
|
|
231
|
+
ANTI: "Esse serviço é simples, não precisa de capacity planning."
|
|
232
|
+
|
|
233
|
+
PROBLEMA: axe pulado vira lacuna; "simples" é subjetivo; decisão baseada em
|
|
234
|
+
assumption sem evidence.
|
|
235
|
+
|
|
236
|
+
CERTO: TODOS os 6 axes preenchidos. Item N/A é resposta válida (com justificativa)
|
|
237
|
+
— pular silenciosamente NÃO é. Para serviços pequenos, model "Simple PRR"
|
|
238
|
+
cobre os 6 em 4-8h.
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### ANTI: PRR como rubber stamp
|
|
242
|
+
|
|
243
|
+
```text
|
|
244
|
+
ANTI: reviewer aprova sem ler evidence; meeting 15 min; checklist marcado "looks good".
|
|
245
|
+
|
|
246
|
+
PROBLEMA: first-incident (em 3-6 meses) revela 5+ gaps; reviewer responsabilidade
|
|
247
|
+
compartilhada por incident.
|
|
248
|
+
|
|
249
|
+
CERTO: reviewer aplica time-budget (4-8h Simple, dias Early); evidence verificada
|
|
250
|
+
em cada item; não-OK = blocker, não "todos têm gaps".
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### ANTI: engagement model errado para custo
|
|
254
|
+
|
|
255
|
+
```text
|
|
256
|
+
ANTI: Simple PRR para tier-1 (outage > $100k/min) OU Early Engagement para internal
|
|
257
|
+
tool com 5 usuários.
|
|
258
|
+
|
|
259
|
+
PROBLEMA: Simple para tier-1 — SRE não engajou no design; problemas estruturais
|
|
260
|
+
inviáveis de fix pós-launch; tier-1 com instabilidade. Early para
|
|
261
|
+
internal tool — over-investment SRE; deslocamento de trabalho importante.
|
|
262
|
+
|
|
263
|
+
CERTO: escolher model conforme custo de outage (regra do glossário: < $1k/min =
|
|
264
|
+
Simple, > $100k/min = Platform).
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### ANTI: PRR one-shot
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
ANTI: passou PRR em 2024, foi para prod, nunca re-PRR'd.
|
|
271
|
+
|
|
272
|
+
PROBLEMA: 2 anos depois — dependency new, RPS 10×, código rewrote, time rotated;
|
|
273
|
+
PRR original irrelevante.
|
|
274
|
+
|
|
275
|
+
CERTO: re-PRR triggered em (a) rewrite > 50%, (b) RPS escala > 10×, (c) novo
|
|
276
|
+
dependency tier-1, (d) time-of-record rotation > 50%, (e) anualmente como
|
|
277
|
+
hygiene.
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
## Verificação
|
|
281
|
+
|
|
282
|
+
Antes de marcar PRR como `Approved`:
|
|
283
|
+
|
|
284
|
+
1. **6 axes preenchidos** — System Architecture, Instrumentation/Metrics/Monitoring, Emergency Response, Capacity Planning, Change Management, Performance
|
|
285
|
+
2. **Cada item tem evidence** — não checkbox vago; evidence concreta (URL/query/doc) em cada
|
|
286
|
+
3. **Engagement model escolhido apropriadamente** — Simple PRR/Early Engagement/Frameworks-Platform conforme custo de outage
|
|
287
|
+
4. **Reviewer ≠ time dev** — reviewer externo ou SRE
|
|
288
|
+
5. **P0s todos resolvidos** — gaps P0 são blockers; nenhum aberto pré-launch
|
|
289
|
+
6. **P1s tracked com owner + due** — escalonados em roadmap próximo
|
|
290
|
+
7. **PRR-REPORT.md em `.planning/prr/<service>.md`** — formato canônico
|
|
291
|
+
8. **Re-PRR trigger documentado** — quando re-PRR é triggered (rewrite, RPS 10×, etc.)
|
|
292
|
+
|
|
293
|
+
## Ver também
|
|
294
|
+
|
|
295
|
+
- [`_shared-sre/glossary.md`](../_shared-sre/glossary.md) — termos canônicos PRR, 6 axes, 3 engagement models
|
|
296
|
+
- [`four-golden-signals`](../four-golden-signals/SKILL.md) — Axe 2 (Instrumentation) exige os 4 signals
|
|
297
|
+
- [`event-based-slos`](../event-based-slos/SKILL.md) (v1.9) — Axe 6 (Performance) exige SLO definido
|
|
298
|
+
- [`burn-rate-alerting`](../burn-rate-alerting/SKILL.md) (v1.9) — Axe 2 (Instrumentation) exige SLO burn-rate alerts
|
|
299
|
+
- [`sre-risk-management`](../sre-risk-management/SKILL.md) — Axe 6 (Performance) requer risk continuum justificativa
|
|
300
|
+
- [`blameless-postmortems`](../blameless-postmortems/SKILL.md) — Axe 3 (Emergency Response) exige postmortem culture
|
|
301
|
+
- [`eliminating-toil`](../eliminating-toil/SKILL.md) — Axe 5 (Change Management) verifica deploy não é toil
|
|
302
|
+
|
|
303
|
+
---
|
|
304
|
+
|
|
305
|
+
*Material-fonte: Site Reliability Engineering — Beyer, Jones, Petoff, Murphy (Google/O'Reilly, 2016) — Cap 32: "The Evolving SRE Engagement Model".*
|