@reaatech/agent-runbook-alerts
v0.1.0
Published
Alert extraction and generation for agent-runbook-generator
Downloads
30
Readme
@reaatech/agent-runbook-alerts
Alert extraction and generation for the Agent Runbook Generator. Extracts existing alert definitions from monitoring configs and generates new SLO-based, resource, and application alerts for Prometheus, Datadog, and CloudWatch.
Installation
npm install @reaatech/agent-runbook-alerts
# or
pnpm add @reaatech/agent-runbook-alertsFeature Overview
- Alert extraction — finds existing alert rules in Prometheus, Datadog, and CloudWatch configs
- SLO-based alerts — generates burn rate alerts from availability and latency targets
- Resource alerts — CPU, memory, and disk saturation alerts with dynamic thresholds
- Application alerts — error rate, request rate, and dependency failure alerts
- Multi-platform formatting — output compatible with Prometheus, Datadog, and CloudWatch
- Default alerts — sensible defaults for services with common dependency patterns
Quick Start
import { extractAlerts, generateAlerts, calculateSloThresholds } from "@reaatech/agent-runbook-alerts";
const existing = extractAlerts("/path/to/repo");
const alerts = generateAlerts(analysisContext, {
sloTargets: { availability: 99.9, latencyP99: 500 },
platform: "prometheus",
});
const thresholds = calculateSloThresholds({
availability: 99.9,
latencyP99: 500,
});API Reference
Alert Extractor
| Function | Signature |
|----------|-----------|
| extractAlerts | (repoPath: string) => ExtractedAlerts |
| generateDefaultAlerts | (serviceName: string, hasDatabase: boolean, hasCache: boolean, hasQueue: boolean) => AlertDefinition[] |
Alert Generator
| Function | Signature |
|----------|-----------|
| generateAlerts | (context: AnalysisContext, config?: AlertGenerationConfig) => AlertDefinition[] |
| formatAlertsForPlatform | (alerts: AlertDefinition[], platform: 'prometheus' \| 'datadog' \| 'cloudwatch') => string |
Threshold Calculator
| Function | Signature |
|----------|-----------|
| calculateSloThresholds | (sloTargets: SLOTargets) => ThresholdRecommendation[] |
| calculateResourceThresholds | () => ThresholdRecommendation[] |
| calculateBurnRateThresholds | (sloTargets: SLOTargets) => ThresholdRecommendation[] |
| getDefaultThresholds | () => ThresholdConfig[] |
| calculateDynamicThreshold | (values: number[], multiplier?: number) => number |
Related Packages
- @reaatech/agent-runbook — Core types and utilities
- @reaatech/agent-runbook-dashboards — Dashboard generation
- @reaatech/agent-runbook-cli — CLI and orchestrator
