Module Catalog¶

AI-SRE is composed of 54 modules under src/, organized by functional area. This page documents every module, its purpose, and whether it is part of the core platform or an optional extension.

Module Overview¶

graph TB
    subgraph Core["Core Modules"]
        ING[ingestion]
        REASON[reasoning]
        ACT[actions]
        ORCH[orchestration]
        POL[policies]
        STORE[storage]
        SEC[security]
        RT[routers]
        SCH[schemas]
        RUN[runtime]
        MOD[models]
    end

    subgraph Intelligence["Intelligence Modules"]
        KNOW[knowledge]
        INTEL[intelligence]
        FORE[forecasting]
        CORR[correlation]
        ANOM[anomaly]
        ANA[analytics]
        RCA[rca]
    end

    subgraph Automation["Automation Modules"]
        AUTO[autonomy]
        RUNB[runbooks]
        WORK[workflows]
        PLAY[playbooks]
        CHAOS[chaos]
        SCALE[scaling]
    end

    subgraph Operations["Operations Modules"]
        NOTIF[notifications]
        ONCALL[oncall]
        POST[postmortem]
        DIG[digest]
        SLO[slo]
        SUPP[suppression]
        COMP[compliance]
    end

    subgraph Integration["Integration Modules"]
        ADAPT[adapters]
        INTEG[integrations]
        SLACK[slack_bot]
        BOT[bot]
        WH[webhooks]
        MCP[mcp]
    end

    subgraph Infrastructure["Infrastructure Modules"]
        MET[metrics]
        OBS[observability]
        REAL[realtime]
        TOPO[topology]
        CLUST[clusters]
        TERRA[terraform]
        MEM[memory]
    end

    subgraph Interface["Interface Modules"]
        UI[ui]
        CLI[cli]
        DEMO[demo]
        READ[readiness]
        REP[reports]
        EXP[export]
        OP[operator]
        CONF[config]
    end

Core Modules¶

These modules are required for the platform to function. They handle alert ingestion, AI diagnosis, action execution, and data persistence.

Intelligence Modules¶

These modules provide pattern recognition, forecasting, and root cause analysis capabilities.

Automation Modules¶

These modules handle autonomous remediation, runbooks, workflows, and proactive operations.

Operations Modules¶

These modules support day-to-day SRE operations: notifications, on-call management, SLOs, and compliance.

Integration Modules¶

These modules connect AI-SRE with external services and provide bot interaction interfaces.

Infrastructure Modules¶

These modules handle observability, infrastructure state, and system topology.

Interface Modules¶

These modules provide user-facing interfaces, demos, and data export capabilities.

Module Enable/Disable¶

# Enable specific modules (all others disabled)
MODULES_ENABLED=ingestion,reasoning,actions,autonomy,notifications

# Disable specific modules (all others enabled)
MODULES_DISABLED=chaos,compliance,terraform,topology

Adding a Custom Module¶

AI-SRE is designed for extensibility. To add a custom module:

1. Create a new directory under src/ (e.g., src/my_module/)
2. Add an __init__.py with your module's public API
3. If the module needs API endpoints, create a FastAPI router and register it in src/ingestion/server.py
4. If the module provides an adapter, register it with the appropriate registry (alert_registry, log_registry, action_registry, or notification_registry)

# src/my_module/__init__.py
"""My custom AI-SRE module."""

# src/my_module/router.py
from fastapi import APIRouter

router = APIRouter(prefix="/my-module", tags=["my-module"])

@router.get("/status")
async def status():
    return {"module": "my_module", "status": "active"}