Skip to main content

Extension Model

This guide outlines a basic model for extending Breeze Agent via simple scripts or small programs executed during the agent run.

Key Concepts​

  • Collector — a script or small program that runs alongside Breeze and emits additional facts or metrics.
  • Execution — collectors are invoked during the agent run and should complete quickly and deterministically.
  • Output — collectors write results as JSON or key=value pairs that Breeze ingests into CMDB.

Patterns​

  • Script collectors:
    • Shell, PowerShell, Python, or similar scripts invoked by the agent.
    • Output structured data (JSON or key=value) to STDOUT or a well‑known file location.
  • Sidecar collectors (Kubernetes):
    • Containers that gather application metrics and write them to a volume mounted by the Breeze pod.
    • Breeze reads these files and publishes them as custom facts.

Guidelines​

  • Keep collectors idempotent and fast (aim for <10s runtime).
  • Use host tags to route and scope where collectors run (for example, app=payments).
  • Reuse patterns from Custom metrics so custom facts integrate cleanly with OS facts and CMDB queries.