Skip to content

docs: add GenAI instrumentation guide and agent observability section#117

Open
Debanitrkl wants to merge 3 commits intomainfrom
docs/genai-instrumentation-guide
Open

docs: add GenAI instrumentation guide and agent observability section#117
Debanitrkl wants to merge 3 commits intomainfrom
docs/genai-instrumentation-guide

Conversation

@Debanitrkl
Copy link
Contributor

Summary

  • Adds the complete agent-observability documentation section to the developer hub
  • Instrumentation Guide (instrumentation-guide.mdx): Full reference for instrumenting any GenAI agent application with OpenTelemetry traces and correlated logs — covers invoke_agent, chat, and execute_tool spans, log records for conversation content, tool calls, thinking/reasoning blocks, OTel Collector configuration, semantic conventions, scenarios, limitations, and troubleshooting
  • Includes cross-span correlation via gen_ai.tool.call.id on both chat and execute_tool spans (single ID as string, multiple IDs as JSON array)
  • Supporting pages: Quickstart, Schema Reference, SQL Query Templates
  • Adds meta.json for sidebar navigation ordering
  • Adds instrumentation guide Card to the index page

Test plan

  • npm run build passes with no MDX/build errors (345 pages generated)
  • Verify page renders at /docs/agent-observability/instrumentation-guide
  • Verify sidebar ordering: index → quickstart → instrumentation-guide → schema-reference → sql-queries
  • Verify internal links work
  • Verify <Callout> components render correctly

🤖 Generated with Claude Code

Add the complete agent-observability documentation section:
- Instrumentation guide: full reference for instrumenting GenAI agents
  with OTel traces and correlated logs (spans, log records, tool calls,
  thinking blocks, cross-span correlation via gen_ai.tool.call.id)
- Quickstart, schema reference, and SQL query templates
- Navigation meta.json for sidebar ordering

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 25, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 25, 2026 6:56am

Request Review

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Relocate the entire section under User Guide in the sidebar nav:
- agent-observability/ -> user-guide/llm-observability/
- Add to root meta.json and user-guide/meta.json
- Update all Card hrefs to new paths
- Remove stale _category_.json and unnecessary redirect_from frontmatter

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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