Skip to content

Workflow — Observability blueprint

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.

Workflow id observability-blueprint · version 1 · Draft (Draft → InReview → Published → Deprecated, BC-04)
Coordinator observability-blueprint-coordinator · family Observability, Security & Compliance
Owner service WorkflowEngineService (BC-38) under Run Control (BC-03)
Starts on readiness bundle readiness-bundle-v1 → RunAccepted from RunControlService when payload.workflowId == 'observability-blueprint' (event)
Steps 5 · gated 0 · agents 1
Budget per run 600000 tokens · cap 60.0 USD · 240 min
Descriptor workflow-definition-v1 · schema
Status target

Builds the Observability Blueprint from the Service and Module Blueprints: spans, metrics and log events per module, health checks, service level objectives and the alerts that guard them; validated against the DSL.

Authored design, Draft (D54, D57)

These definitions were authored from the coordinator cards as design assumptions. None is published, evaluated or has run; agents are named by id as design bindings, not as tested integrations.

Activation (readiness bundle)

The Workflow Engine's readiness correlation (BC-38, ADR-0026) joins the signals below per project and bundle fingerprint and submits one run through Run Control's SubmitRun; the run then starts on RunAccepted like every other definition. Nothing starts on a raw event.

Slot Kind Descriptor Required Satisfied by Predicate
service-blueprint blueprint (Service) blueprint-service-v1 yes BlueprintService.BlueprintValidated payload.kind == 'Service' and payload.passed == true
module-blueprints blueprint (Module) blueprint-module-v1 yes BlueprintService.BlueprintValidated payload.kind == 'Module' and payload.passed == true
  • Consistency: members are satisfied only within the trusted tenant and project of the signal; a newer version of any member opens a new correlation and supersedes the open one
  • Fingerprint: sha256 over the sorted list of slot🆔version:hash of every satisfied required and optional member
  • Idempotency key: {scope}:{operation}:{workflowReleaseId}:{bundleFingerprint}
  • Deduplication: the same key returns the existing run (SubmitRun: same Idempotency-Key, same canonical body); a new member version yields a new fingerprint and a new correlation, and the Open one is Superseded; a different body under the same key is a 409 and the correlation is Superseded with reason conflict
  • Submit: workflow observability-blueprint (release alias latest), model profile code-agent, input readiness-bundle-v1, client reference correlationId.

Definition

flowchart TD
    start(("RunAccepted"))
    derive_signals["Derive the signals"]
    draft_observability_blueprint["Draft the Observability Blueprint"]
    submit_version[["tool: Submit the Draft version"]]
    validate[["tool: Validate the blueprint"]]
    check_valid{"Validation passed?"}
    start --> derive_signals
    derive_signals --> draft_observability_blueprint
    draft_observability_blueprint --> submit_version
    submit_version --> validate
    validate --> check_valid
    done(("WorkflowRunCompleted"))
    check_valid --> done
    check_valid -. "retry up to 2" .-> draft_observability_blueprint
    classDef gated stroke:#B45309,stroke-width:2px
Hold "Alt" / "Option" to enable pan & zoom

Shapes: rectangle = agent attempt · double rectangle = tool call · stadium = human decision · diamond = condition evaluated by the engine over recorded outputs · parallelogram = fan-out or join · circle = timer · cylinder = sub-workflow · flag = compensation. A thick amber border marks a gated step; a dashed edge is a bounded on_false loop. A step with a when guard runs only when its predicate over recorded outputs holds; otherwise the engine records it Skipped and its dependants treat it as satisfied (ADR-0027).

Steps

# Step Kind Runs Gate Class Depends on Retry Timeout Compensation What it does
1 Derive the signals
derive-signals
agent observability-engineer
skill observability-engineer-derive-signals
none read — exponential ×3 (30s) PT30M — Spans, metrics and log events per module and per published operation, with the attributes the observability conventions require and the objectives the Service Blueprint states.
2 Draft the Observability Blueprint
draft-observability-blueprint
agent observability-engineer
skill observability-engineer-draft-observability-blueprint
none sandbox derive-signals exponential ×3 (30s) PT30M — Writes the Observability Blueprint: the signal catalogue per module, health checks, service level objectives with their indicators, and alert rules with their routes.
3 Submit the Draft version
submit-version
tool blueprint-submit-version none shared-write draft-observability-blueprint fixed ×2 (10s) PT2M — Stores the document as a project-scope Draft BlueprintVersion of its kind (idempotent on document hash); a shared write that the project policy may gate; Draft versions are autonomous by default (D64).
4 Validate the blueprint
validate
tool blueprint-validate none sandbox submit-version fixed ×2 (10s) PT5M — BlueprintService validates the version against blueprint-observability-v1 and its rule set and returns a receipt; BlueprintValidated is emitted with passed true or false.
5 Validation passed?
check-valid
condition engine none read validate none PT1M — Engine condition over the recorded receipt; findings go back to the draft step up to twice, then the run fails with the report. Condition: steps.validate.validation-receipt.passed == true. On false: back to draft-observability-blueprint up to 2 time(s) with steps.validate.validation-receipt.

Step contracts

Step Inputs (name ← source) Outputs (name: descriptor)
derive-signals service-blueprint ← input.service-blueprint
module-blueprints ← input.module-blueprints
signal-plan: artifact-v1
draft-observability-blueprint service-blueprint ← input.service-blueprint
module-blueprints ← input.module-blueprints
signal-plan ← steps.derive-signals.signal-plan
observability-blueprint-draft: blueprint-observability-v1
submit-version document ← steps.draft-observability-blueprint.observability-blueprint-draft version-ref: blueprint-version-ref-v1
validate version-ref ← steps.submit-version.version-ref validation-receipt: blueprint-validation-receipt-v1
Every mapping names its source (input.* a workflow input, steps.* an ancestor's recorded output, bundle.* a readiness member) and the validator checks that every required input of the step's agent is mapped and that descriptors agree.

Gates and approvals

  • shared-write: creating a Draft blueprint version in project scope is autonomous unless the project policy (BC-20) gates blueprint drafts, in which case an approval bound to the document hash is requested (D64) Compensation steps run in reverse order of the succeeded steps on failure after the last checkpoint; a step without a compensation leaves its sandbox output in place and the run ends Failed with the evidence (ADR-0014, recovery not replay).

Inputs, outputs and events

Direction Name Descriptor Required
in service-blueprint blueprint-service-v1 yes
in module-blueprints blueprint-module-v1 yes
out observability-blueprint blueprint-observability-v1 yes
out validation-receipt blueprint-validation-receipt-v1 yes

Starts on RunAccepted from RunControlService when payload.workflowId == 'observability-blueprint'; emits BlueprintValidated, plus the engine's WorkflowRunStarted, StepReady, StepRunStateChanged and WorkflowRunCompleted / WorkflowRunFailed and Run Control's run and attempt events (ADR-0014).

Decisions and traceability

  • FR: FR-11 Compatible templates and libraries through release gates
  • XL: XL-09 Generation yields a usable consumer
  • ADRs: ADR-0014, ADR-0024, ADR-0026, ADR-0027, ADR-0030 · ADR index

Definition authored 2026-11-05 so that no awaited blueprint kind depends on a person authoring it by hand (ADR-0030, D78); Draft until an evaluation gate (ADR-0021) and a review publish it as a BC-04 asset release. Validation is a tool call with a receipt and a bounded on_false loop (ADR-0026, D61).