Skip to content

docs(positioning): observability story#649

Merged
rickylabs merged 1 commit into
mainfrom
docs/445-positioning-observability
Jul 11, 2026
Merged

docs(positioning): observability story#649
rickylabs merged 1 commit into
mainfrom
docs/445-positioning-observability

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

Closes #445

Workstream D6 of epic #401: pitch + "one grouped trace" Flow-B story spine + ports/adapters and #402 convention mechanism on observability/telemetry.md, plus a new "Close the loop: read the trace back in code" section (typed TelemetryQueryPort read side: createAspireTelemetryQuery/createTelemetryQuery, query surface, read models, Standard Schema validators) with the single factual comparison (Encore MCP-server trace access vs in-language port); observability/index.md — verification-turn pitch + convention link. Claims re-verified via deno doc + the canonical telemetry README (PR #610); the correlation-id mention stays within published-beta.7 naming-convention language (the #626 floor is unreleased).

Validation: deno task verify green (23,019/23,019 links; 27/27 caveats); positioning-law grep clean (Jaeger/Grafana/Honeycomb are neutral OTLP-backend references). Worklog on-branch at .llm/runs/docs-445-positioning-observability--docs/worklog.md.

Lane note: started on Fable, spend-limit terminated mid-edit; completed by an Opus 4.8 resume agent that reviewed-not-trusted the partial edits (run eval D6). Validation verdict remains #450. Docs-only diff → ci:skip-e2e + ci:skip-scaffold.

…ery read side (#445)

Reframe the observability pillar around the build-efficiency law: the verification
turn ("did the change work across every process?") is the expensive turn, and
NetScript closes it inside the framework.

telemetry.md:
- elevator-pitch intro (verification-turn / agent self-verify framing)
- "one grouped trace" story spine (Flow-B: trigger → scheduler → queue →
  job.execute → SDK rpc.client callback; createFanInLinks span links;
  gate-enforced; gen_ai.* for AI turns)
- telemetry ports/adapters + #402 attribute convention mechanism paragraph
- service/RPC/HTTP tracing: registerORPCInstrumentation + first-party
  createHonoTracingMiddleware
- new "Close the loop" section: typed TelemetryQueryPort read side +
  the single factual Encore comparison (MCP trace access vs in-language port)

index.md: pitch-led intro, "read a trace back in code" next-step, convention link.

All present-tense API claims trace to deno doc (query.ts/orpc.ts) + canonical
README (PR #610); published beta.7 surface only. deno task verify green
(build + 23019 links resolve + 27 caveats resolve).

Refs #445

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DiTbVL2p3zLYc9AxxpK8iG
@rickylabs
rickylabs marked this pull request as ready for review July 11, 2026 13:36
@rickylabs
rickylabs merged commit aaaae81 into main Jul 11, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(positioning): observability story

1 participant