Skip to content

docs(prismml): add Bonsai Python tracing guide - #1097

Draft
nik13 wants to merge 3 commits into
mainfrom
docs/prismml-bonsai-python
Draft

nik13 wants to merge 3 commits into
mainfrom
docs/prismml-bonsai-python

Conversation

@nik13

@nik13 nik13 commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Merge hold: genuine fixed tracing release required

Do not publish/merge this guide yet. The latest published tracing pins (traceAI-openai==0.1.12, fi-instrumentation-otel==1.2.2) still lose request cancellation spans. The exact guide now has a mandatory cancellation contract: the original interruption must propagate and its finally/force_flush must export one ERROR span. This fails with published pins at both OpenAI bounds, rather than silently accepting lost telemetry.

Shared repair dependencies: future-agi/traceAI#520 and future-agi/traceAI#536. Built packages from #536 at 93907f3cfbbd39f18a6e3a3ad11171757b81057e (which includes #520) pass the complete guide and recipe contracts. They are not yet genuine fixed releases. No unpublished version is placed in customer installation commands.

Unblock only after the shared fixes pass their merge/release gates and real registry versions are available: update this page's install pins, its CI install step and static contracts, and the README/requirements in future-agi/traceAI#542; rerun the published floor/latest matrices. The guide also describes the CLI completion fix in #542, so that change must land before publication.

Summary

Add the discoverable PrismML Bonsai how-to using the maintained OpenAI instrumentor, not copied tracing glue. Cover server startup, stable model aliases, separate model and Future AGI credentials, correct OTLP origin, exact runnable Python setup, privacy and actionable troubleshooting.

This recall update:

  • Adds a cancellation release gate to the exact documented Python block, preserving the original KeyboardInterrupt object.
  • Exercises the SDK's default HTTP client at both bounds (httpx at the floor, httpx2 at latest), without replacing the instrumented method.
  • Explains that the ready-to-run streaming CLI exits 1 for a missing finish reason and printed text must be treated as partial.
  • Keeps release/QA evidence out of the customer page; the engineering hold is recorded here and in the mandatory tests.

Verification

Sandboxed, synthetic credentials, isolated HOME and loopback HTTP/OTLP only; no live model or Cloud calls.

  • Published pins: exact guide 3 passed, 1 failed at Python 3.10 / OpenAI 1.69.0 and Python 3.13 / OpenAI 3.42.1. The failure is the intentionally unsuppressed cancellation release gate.
  • With built Fix FAQ (full rewrite) and Prism configuration duplicates #536 shared packages: exact guide 4 passed and combined recipe + guide 131 passed at each bound.
  • Companion CLI application-only incomplete-stream tests failed before the fix and now pass; shared published telemetry remains blocked.
  • Static page/catalog/scaffold tests: 24 passed; integration type check passed.
  • Link audit: 0 broken navigation/content links, 28 existing orphan-page warnings.
  • Full Astro/Pagefind build passed, indexing 799 pages; existing redirect pages emit no-html warnings.
  • Built page rendered in isolated desktop Chrome: HTTP 200, 6 code blocks, no page errors or horizontal overflow. Visually checked the actual page, not a product mockup.
  • Normally merged current main 2eb5f964; diff checks pass. No lockfile change, registry publication or merge.

No product E2E harness applies. The screenshot verifies documentation rendering only, not live Bonsai inference or Future AGI Cloud ingestion.

🤖 Generated with Claude Code

Add a discoverable guide, exact-snippet loopback OTLP contracts and floor/latest CI without a copied instrumentation helper.

Co-Authored-By: Claude Code <noreply@anthropic.com>
nik13 and others added 2 commits November 2, 2026 09:26
Co-Authored-By: Claude Code <noreply@anthropic.com>
Exercise the exact guide cancellation path and explain incomplete CLI responses without copying tracing helpers. Fixed package pins remain blocked on the shared repair release.

Co-Authored-By: Claude Code <noreply@anthropic.com>
@nik13
nik13 marked this pull request as draft November 2, 2026 17:50

This branch has not been deployed

No deployments
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.

1 participant