docs(observability): define OpenTelemetry best practices - #503
Open
tucktuck101 wants to merge 1 commit into
Open
docs(observability): define OpenTelemetry best practices#503tucktuck101 wants to merge 1 commit into
tucktuck101 wants to merge 1 commit into
Conversation
Signed-off-by: tucktuck101 <jeffreytaylorrobertson@gmail.com>
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
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
Adds a version-pinned, primary-source definition of OpenTelemetry instrumentation best practice and maps it to every Buzz product runtime boundary in issue #493. The artifact separates normative requirements, Stable conventions, experimental guidance, local recommendations, and deferred decisions while preserving ADR-0023 through ADR-0026, the infrastructure ownership boundary, and the mobile exclusion.
Related issue
Closes #493
Issue type
Task
Agent provenance
Objective
Create the issue #493 source-backed OpenTelemetry best-practice research artifact and Buzz runtime applicability map without designing instrumentation or infrastructure.
Impacted components
launchpad/Research/493-otel-instrumentation-best-practices.mdApproach and rejected alternatives
Used OpenTelemetry Specification 1.60.0, Semantic Conventions 1.44.0, an exact OpenTelemetry GenAI conventions commit, W3C Trace Context Level 2, and dated official browser documentation. Claims are explicitly classified by authority and maturity, then mapped to product/infrastructure ownership and downstream issue owners. Rejected an SDK/package inventory because that is #462, a Buzz-specific telemetry schema because ADR-0023 requires OpenTelemetry conventions first, and exporter/collector/platform design because those belong to desired-state work and buzz-infrastructure#113.
Verification
Command run:
Raw output:
Not verified
Did not inventory current runtime instrumentation or SDK capabilities because those are #462 and #463-#476. Did not run a live relay, desktop/browser client, exporter, collector, or broad repository CI because this change is research-only and the assignment requires the smallest final documentation/source checks.
Security implications
This documentation-only change adds no runtime exposure. It preserves ADR-0025's prohibited-content, classification, filtering, truncation, consent, and cardinality boundaries and treats propagated context as untrusted correlation data rather than identity or authority.
Escalations
No new ADR is proposed. The absence of Stable WebSocket/Nostr carriers, Development browser/messaging/GenAI/MCP conventions, sampling/profile policy, and per-runtime SDK capability remain explicit uncertainties assigned to the existing current-state, desired-state, profile, and infrastructure issues.