Welcome to Circuit Breaker

Circuit Breaker

Circuit Breaker is a self-hosted app for mapping your infrastructure in one place.

You can track your hardware, compute, services, storage, and networks, then see how everything connects on a live topology map. You can also attach notes and runbooks to the things you manage so your documentation stays with your inventory.

Start with Installation to get Circuit Breaker running, then use Getting Started to add your first assets. Feature guides are in the left navigation.

For release-candidate planning, see the draft v1.0 support contract.

Building on Circuit Breaker, or evaluating the codebase? The architecture walkthrough traces every data path through the system in nine annotated diagrams.

Why Circuit Breaker?

  • See the full picture: Understand where each service runs and what it depends on.
  • Keep docs where work happens: Attach notes, links, and runbooks directly to your assets.
  • Plan changes with confidence: Use dependencies and audit history to reduce surprises.

Core Concepts

In Circuit Breaker, your lab is built upon these fundamental layers:

  1. Hardware: Physical components like servers (nodes), switches, firewalls, NAS units, UPS devices, and more.
  2. Compute: Virtualized environments that run on your Hardware, such as VMs and LXC containers.
  3. Services: The actual applications you host (e.g., Plex, Home Assistant, databases), which run on your Compute units.
  4. Storage & Networks: Shared resources that Services and Hardware depend on, such as storage pools, ZFS datasets, and VLANs.
  5. Topology Map: A live visual map of how your components connect, including health rings when telemetry is enabled.
  6. Audit Log: A searchable activity history showing what changed, who changed it, and when.

To see how to begin adding these components, proceed to Getting Started.

Key Features Available Now

  • Auto-Discovery (Beta): Scan selected network ranges, review results, then merge approved items into your inventory.
  • cb-agent: Install a small Linux daemon on a remote site or a separate VLAN so Circuit Breaker can collect host telemetry, run monitor probes, and discover from inside a network the server cannot reach.
  • Settings: Control timezone, appearance, map defaults, and system behavior.
  • Authentication & Access: Local auth, OAuth/OIDC, MFA, invites, and recovery workflows.
  • Notifications: Route alerts to notification sinks and manage delivery.
  • Monitoring: Native ICMP, TCP, HTTP, and DNS checks with live status, uptime history, and latency history, on hardware, compute units, and services.
  • Backup & Restore: Export your inventory snapshot and restore when needed.
  • Deployment & Security: Choose a quick lab setup or a hardened setup.

Integrations

  • Hardware Telemetry — Connect to Dell iDRAC, HPE iLO, APC/CyberPower UPS, or any SNMP device to show live health data directly on the topology map.
  • Proxmox — Connect a Proxmox node with an API token to import QEMU VMs and LXC containers, map them to their host hardware, and pull node telemetry.
  • Prometheus Metrics — Scrape Circuit Breaker inventory data with Prometheus, Grafana Alloy, or any compatible agent. Includes a full metrics reference, scrape config examples, and PromQL queries.