Skip to content

docs(api): tracing endpoint docstrings + concept page#4235

Draft
mmabrouk wants to merge 1 commit intomainfrom
docs/age-3734-tracing-endpoints
Draft

docs(api): tracing endpoint docstrings + concept page#4235
mmabrouk wants to merge 1 commit intomainfrom
docs/age-3734-tracing-endpoints

Conversation

@mmabrouk
Copy link
Copy Markdown
Member

Summary

  • Adds 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), the ag.* namespace and both flat / nested wire formats, the ag.unsupported fallback (product commitment to never drop telemetry), and the focus query mode.
  • Adds Field descriptions and handler docstrings across tracing/, traces/, and otlp/ routers and models.
  • Builds on the PR docs(api): reference docs for tracing ingest/query and create-simple-trace endpoints #4174 baseline (which docstring'd ingest_spans, query_spans, create_simple_trace); extends to all the other endpoints and adds the concept page.

Process notes

  • Pre-commit / gitleaks were not available in the sandbox; commit was made with --no-verify. No secrets touched. Hooks should be re-run locally before merge.
  • Agent died on API rate limit before pushing; salvaged from the worktree.

Related

Test plan

  • Endpoints exercised against eu.cloud.agenta.ai
  • Examples obfuscated; shapes match real responses
  • Reviewer: re-run pre-commit hooks locally before merge
  • Reviewer: confirm the references-vs-links framing matches product intent
  • Reviewer: confirm the four-ingestion-path decision tree

- 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.
@linear
Copy link
Copy Markdown

linear Bot commented Apr 28, 2026

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agenta-documentation Error Error Apr 28, 2026 10:17am

Request Review

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