bmad-observability-agent

Quick Start

Get from zero to production-grade observability using the B-MAD O11y Engineer agent.

Prerequisites

Step 1: Install the Module

See the Installation Guide for detailed instructions. The quickest path:

npx bmad-method install --custom-source https://github.com/henrikrexed/bmad-observability-agent

Step 2: Start the Agent

Invoke the O11y Engineer:

/o11y-engineer

The agent will greet you and display a numbered menu of all available capabilities.

Step 3: Run the Assessment

Start by understanding your current observability state. Select AM from the menu or run:

Select: AM (Assess Observability Maturity)

The assessment evaluates:

You’ll receive a score from 0-100 with a prioritized improvement roadmap.

Step 4: Follow the 8-Phase Workflow

Based on your assessment, follow the recommended 8-phase workflow:

  1. Assessment (done) – You know where you stand
  2. Observability Spec – Define what telemetry your services need
  3. Collector Configuration – Build the OTel Collector pipeline
  4. CI/CD with Weaver – Automate semconv validation
  5. SLO Definition – Set performance/reliability/availability targets
  6. MCP Rules – Generate IDE integration for your team
  7. Implementation – Hand off to dev agents for instrumentation
  8. Validation – Verify everything works against the spec

Step 5: Validate

After implementation, validate that your telemetry matches the spec. Select VO from the agent menu:

Select: VO (Validate Observability Setup)

This runs the mandatory 5-step Query Validation Gate and produces a detailed report.

Common First Commands

Agent Menu Code Skill Purpose
AM /o11y-engineer Evaluate current observability maturity
QS /o11y-engineer Full guided setup from scratch
CP /o11y-engineer Design OTel Collector pipeline
QC /o11y-engineer Run quality checks (0-100 score)
WO /o11y-write-ottl Write OTTL expressions
GE /o11y-generate-epics Generate sprint-ready epics
IA /o11y-instrument-app Add OpenTelemetry to apps
RP /o11y-redact-pii Configure PII redaction

Next Steps