Repository navigation
docs(#9398): align tracing guides and comments with the code - #9400
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
The tracing guides and two code comments described behaviour the code does not have. Wording only; no behaviour changes. - distributed-tracing.md: name the cache token attributes as emitted (gen_ai.usage.cache_creation.input_tokens and gen_ai.usage.cache_read.input_tokens, run.go) instead of the underscore shorthand; drop "once Level 3 is implemented", since Level 3 capture exists (content_collector.go), and link its section. - eval-measurements.md: point the Level 3 row at the content capture section instead of the closed #5947 draft; drop "once L3 is implemented". - dev/tracing.md: add content.go, content_test.go and tracecontext/ to the package layout. - tool_spans_test.go: codex emits id-less ToolUseEvents and no results; pi emits ids and results, leaving the id off only when it never saw the call's start line. - telemetry.go: Setup returns a noop tracer only when OTEL_SDK_DISABLED is true or the telemetry file cannot be opened; OTLP endpoint/header/exporter failures warn and keep the file exporter. Note: pre-commit could not fetch remote hook repos (TLS failure in the sandbox). Ran local hooks directly: gofmt, go vet, lint-docs-links, lint-broken-symlinks and lychee all pass. Closes #9398 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Site previewPreview: https://c1c17451-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 11:52 PM UTC · Completed 11:59 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.34 |
|
Risk Assessment: moderate (2/5) DetailsSmall documentation and comment alignment by a bot with well-scoped issue context is elevated to moderate risk due to high recent churn and coupling in active tracing documentation files. |
|
Looks good to me Labels: PR updates user-facing tracing documentation. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This branch was successfully deployed
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
Changes the tracing guides and two code comments so they say what the code does. Only wording changes; behaviour stays the same.
Changes
docs/guides/infrastructure/distributed-tracing.mdgen_ai.usage.cache_creation.input_tokens,gen_ai.usage.cache_read.input_tokens, seeinternal/cli/run.go), replacing the underscore shorthand.internal/cli/content_collector.go), and the paragraph now links to the guide's own "Content capture (Level 3)" section.docs/guides/infrastructure/eval-measurements.md: the Level 3 row now links to that content capture section instead of the closed docs(adr): specify Level 3 content capture activation and sandbox env denylist #5947 draft, and no longer says "once L3 is implemented".docs/guides/dev/tracing.md: the package layout now listscontent.go,content_test.goandtracecontext/(ADR 0154).internal/cli/tool_spans_test.go: the comment now says codex emits ToolUseEvents with no id and no results. Pi does emit ids and results (internal/runtime/pi_progress.go). It leaves the id off only when it never saw a call's start line.internal/telemetry/telemetry.go: theSetupdoc comment now splits the two cases. The noop tracer is returned only whenOTEL_SDK_DISABLEDis set or the telemetry file can't be opened. A failed OTLP endpoint check, header check or exporter setup prints a warning and keeps the file exporter.Testing
pre-commitcouldn't fetch its remote hook repos in the sandbox (TLS certificate failure), so I ran the local hooks directly.gofmt,go vet,lint-docs-links,lint-broken-symlinksandlychee --offline --include-fragments(which checks the new anchor links) all pass. The remote hooks (trailing whitespace, end-of-file, gitleaks) did not run.scan-secretsandgitlintpass.go test ./internal/telemetry/andgo test ./internal/cli/ -run TestToolSpanTrackerpass.Context
Open PR #7553 edits the same table row and keeps the underscore shorthand. Whichever PR merges second will need a rebase.
🤖 Generated with Claude Code
Closes #9398
Post-script verification
agent/9398-tracing-docs-match-code)280cab9d401024acc7e824c9555804b7981a7c88..HEAD)