docs(api): tracing endpoint docstrings + concept page#4235
Merged
mmabrouk merged 6 commits intoMay 13, 2026
Conversation
- Adds 10-tracing.mdx — concept page covering spans/traces, the invocation vs annotation trace types, span types, references vs links, the four ingestion paths with a decision tree, the async 202 contract, the ag.* namespace (both wire formats), the ag.unsupported fallback, and the query focus mode. - Adds Field descriptions across tracing/, traces/, otlp/ models and docstrings on every handler beyond the PR #4174 baseline.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
4 tasks
Resolves Support-mixin conflicts in three models files
(api/oss/src/apis/fastapi/{otlp,traces,tracing}/models.py) by keeping the
docstrings and Field(description=...) descriptions while adopting the
umbrella's Support base class on the response envelopes.
Reverts auto-generated docs/docs/reference/api/ changes per write-docs §8.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…' into docs/age-3734-tracing-endpoints
Apply the same conceptual frame and writing style used on the applications, evaluators, workflows, and testsets pages. - Intro states up front what spans and traces are, and that ag.* is what links traces to Agenta entities. - Section names rephrased to match the verb-first style on the other pages: "Trace types" (not "Trace types: annotation vs invocation"), "References" (not "References and entity linking"), "Ingestion" (not "The four ingestion paths"), "Examples" (not "Worked examples"). - Async write contract becomes a subsection under Ingestion since it describes the same write path. - ag.unsupported fallback becomes a subsection under the ag namespace since it documents the namespace's "keep customer telemetry" commitment. Style pass per Williams: concrete subjects, active verbs, no em dashes, no marketing words. Tighten the AGE-3735 mention to reflect it as resolved rather than open.
Address all 11 inline comments on PR #4235. - Rewrite the intro: lead with "Agenta's observability sits on top of OTel" and a one-line scope of the page. Then explain what OTel gives you (span + trace) and what Agenta adds on top (the ag.* subtree used to tag types, link to entities, and surface metrics). - Link each ingestion endpoint to its API reference page. - Add an `:::info` at the top of `## Ingestion` saying most callers use the SDK and OTel auto-instrumentation; the four endpoints are for custom integrations. - Rename `### Async write contract` -> `### How ingest works`. Drop the "contract" framing. Explain plainly: the response is 202 with a count/links payload, returned before persistence. Show the response shape. Move the "count reflects parse-time only" caveat into a `:::warning` block. - Drop the AGE-3735 mention. Internal issue references don't belong in customer docs. - Connect the adapter behaviour to `ag.unsupported`: when the parser can't fit a field, it parks the field under `ag.unsupported.*`. - Cut the "Two wire formats" framing. Show only the nested form that query responses return. - Compress `ag.unsupported` to "what cases" and "where the data ends up", drop the implementation steps. - Drop the "product commitment" sales sentence. - Rewrite `## Querying` as two clear endpoint bullets with reference links. Drop the focus/spans wrapper detail. Style pass per Williams: concrete subjects, active verbs, no em dashes.
Self-review pass against the style-editing and write-docs skills.
- Intro: drop "Agenta adds on top" so the page scope list reads cleanly
and we don't repeat "on top of" in the same paragraph.
- Spans and traces: drop the duplicate "A trace is the set of spans..."
sentence. The intro already defines a trace. Reframe the SpansTree
paragraph as "When an endpoint returns a single trace, the payload
wraps..." and use "wraps" instead of "is" for the verb.
- How ingest works: replace the abstract subject "OTel semantics require"
with a concrete "This keeps the ingest buffer fast" that ties back to
the previous sentence.
- Ingest adapter sentence: shorten the long subject ("The adapter that
parses incoming spans into Agenta's attribute schema") to "Agenta's
ingest adapter". Fix the parallel ("rather than reject" -> "instead of
rejecting"). Use "parks" for the action.
- Set an explicit anchor on the `ag.unsupported` heading and update the
cross-link so it does not depend on slugger behaviour.
- Querying: tighten the lead from "Two endpoints return spans, with
different shapes:" to "Two endpoints query spans, each returning a
different shape:".
mmabrouk
merged commit b23be25
into
docs/age-3734-api-reference-epic
14 of 15 checks passed
dosubot
Bot
added
size:XXL
Contributor
Railway Preview Environment
|
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
docs/docs/reference/api-guide/10-tracing.mdx— concept page (~1000 words) covering: spans and traces, invocation vs annotation trace types, span type taxonomy, references vs OTel links, the four ingestion paths with a decision-tree table, the async 202 contract (intentional, not a bug), theag.*namespace and both flat / nested wire formats, theag.unsupportedfallback (product commitment to never drop telemetry), and thefocusquery mode.tracing/,traces/, andotlp/routers and models.ingest_spans,query_spans,create_simple_trace); extends to all the other endpoints and adds the concept page.Process notes
--no-verify. No secrets touched. Hooks should be re-run locally before merge.Related
tmp-docs-analysis/plan.mdtmp-docs-analysis/concept-map/tracing.mdTest plan