docs: design note on OTel instrumentation pros + cons#47
Merged
ColonistOne merged 1 commit intomainfrom Apr 29, 2026
Merged
Conversation
Filed under docs/design-notes/ — analysis only, no implementation decision taken yet. Captures the trade-offs surfaced while exploring whether to ship OTel instrumentation in colony-sdk for fan-out across five AI-agent observability platforms (Langfuse, Langtrace, Arize Phoenix, Traceloop / OpenLLMetry, W&B Weave). Pros: integration-directory listings as backlinks, tutorial fan-out, production debugging value beyond marketing, betting on the dominant standard, rich-attribute upgrade vs generic auto-instrumentation, existing live agents (Eliza-Gemma + Langford) as ready demos. Cons: privacy / attribute-leak hygiene (the most material concern — attributes flow off-host to third-party observability backends), auto-instrumentation already covers most basic visibility, OTel GenAI semconv still incubating, async context propagation gotchas, 100% coverage burden, double-span noise when both ours and httpx auto-instrumentation are installed, version churn, opinion lock-in. Net: not a clear yes or no. Worth revisiting after GenAI semconv stabilises, after concrete integration requests come in from real users, or after testing the narrower "Langfuse-only callback" version to gauge directory-listing traction before broadening. Wired into docs/index.rst under a new "Design notes" toctree so it renders on the Sphinx site. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Filed at
docs/design-notes/otel-instrumentation-analysis.md. Analysis only — no implementation decision taken yet.Captures the trade-offs surfaced while exploring whether
colony-sdkshould ship OpenTelemetry instrumentation for fan-out across Langfuse, Langtrace, Arize Phoenix, Traceloop / OpenLLMetry, and W&B Weave.Pros: integration-directory listings as backlinks, tutorial fan-out, production debugging value beyond marketing, betting on the dominant standard, rich-attribute upgrade vs generic auto-instrumentation, existing live agents (Eliza-Gemma + Langford) as ready demos.
Cons: privacy / attribute-leak hygiene (most material concern), auto-instrumentation already covers most basic visibility, OTel GenAI semconv still incubating, async context propagation gotchas, 100% coverage burden, double-span noise, version churn, opinion lock-in.
Net: not a clear yes or no. Filed for revisit after GenAI semconv stabilises, concrete integration requests come in, or a narrower Langfuse-only callback test materialises traction.
Wired into
docs/index.rstunder a new "Design notes" toctree so it renders on the Sphinx site.Test plan
requirements.txt)🤖 Generated with Claude Code