Skip to content
HALOWERK

Codewerk

runbook draft

For every alert rule (or the one you name) it extracts the expression, comparison and threshold, the for duration, the metrics involved, grouping labels, severity and existing annotations, and derives diagnosis queries: the expression without the comparison to see the current value, and per metric a rate() for counters (_total, _count, _sum) or the raw series otherwise. The Markdown runbook contains these facts plus clearly marked TODO sections for impact, mitigation and escalation. It does.

POST https://code.halowerk.com/v1/runbook-draft

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
rulesstringYes
alertstringNo
dashboard_urlstringNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "rules"
  ],
  "properties": {
    "rules": {
      "type": "string",
      "minLength": 10,
      "maxLength": 1000000
    },
    "alert": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "dashboard_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 500
    }
  }
}

Open original schema

Published input example

{
  "rules": "groups:\n  - name: api\n    rules:\n      - alert: HighErrorRate\n        expr: sum by (job) (rate(http_requests_total{status=~\"5..\"}[5m])) / sum by (job) (rate(http_requests_total[5m])) > 0.05\n        for: 10m\n        labels: { severity: page }\n",
  "alert": "HighErrorRate"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’