Skip to content

docs: document provider SDK auto-instrumentation - #365

Merged
rite2hhh merged 5 commits into
masterfrom
docs/openai-sdk-auto-instrumentation
Aug 4, 2026
Merged

docs: document provider SDK auto-instrumentation#365
rite2hhh merged 5 commits into
masterfrom
docs/openai-sdk-auto-instrumentation

Conversation

@rite2hhh

@rite2hhh rite2hhh commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add provider SDK auto-instrumentation guides for OpenAI, Anthropic, Google, and AWS Bedrock.
  • Cover Python and JavaScript where supported, including direct Boto3 Bedrock Runtime calls in Python.
  • Document supported API surfaces, installation, initialization order, provider selection, exporter configuration, and flushing.
  • Explain content capture and its privacy tradeoffs, including Bedrock operation-specific payload coverage and streaming behavior.
  • Clarify that Bedrock uses process-wide Botocore instrumentation, which also traces other Botocore service calls.
  • Explain when to use SDK auto-instrumentation, manual tracing, OpenTelemetry, or telemetry integrations.
  • Improve discovery of framework, model-router, and agent integrations.

Validation

  • mint validate
  • mint broken-links
  • Focused Python SDK tracing tests: 77 passed

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
promptlayer 🟢 Ready View Preview Jul 28, 2026, 3:04 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5b8486ce01

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread sdks/evals/agent-tracing.mdx Outdated
- **A framework helper** — OpenAI Agents, Claude, Vercel AI, and the rest in [Telemetry Integrations](/features/integrations) — which instruments your tools automatically.
- **`traceTool`** on a custom agent's tool handlers. It records the `Tool: <name>` span for you (on a tracing-enabled client); see [Tracing Tools](/running-requests/traces#tracing-tools) for the full contract.
- **A framework helper** — OpenAI Agents, Claude, Vercel AI, and the rest in [Telemetry Integrations](/features/observability/traces/integrations) — which instruments your tools automatically.
- **`traceTool`** on a custom agent's tool handlers. It records the `Tool: <name>` span for you (on a tracing-enabled client); see [Tracing Tools](/features/observability/traces#tracing-tools) for the full contract.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Fix stale tracing-tools anchor

This updated link still points at #tracing-tools, but the new traces page defines the section as ## Trace Tools, which generates #trace-tools; the same stale fragment appears in the other eval docs, so users following these links no longer land on the traceTool instructions. Either restore the old anchor/heading or update all new links to the generated fragment.

AGENTS.md reference: AGENTS.md:L72-L72

Useful? React with 👍 / 👎.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
promptlayer 🟡 Building Jul 28, 2026, 3:03 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

rite2hhh added 2 commits July 29, 2026 13:30
Add Python and JavaScript setup for supported OpenAI APIs.
Explain initialization, content capture, exporter configuration, flushing, and verification.
Clarify how provider instrumentation relates to PromptLayer traces and request logs.
Group request-log configuration under Request Logs and tracing configuration under Traces.
Move Search and Analytics into Core Concepts and remove redundant Advanced hubs.
Update canonical paths, backlinks, and redirects from pages published on master.
@rite2hhh
rite2hhh force-pushed the docs/openai-sdk-auto-instrumentation branch from 803355d to 53815fd Compare July 29, 2026 18:50
@rite2hhh
rite2hhh force-pushed the docs/openai-sdk-auto-instrumentation branch from 53815fd to d3f6e90 Compare July 29, 2026 18:55
@rite2hhh rite2hhh changed the title docs: add OpenAI SDK auto-instrumentation and simplify observability docs: document OpenAI, Anthropic, and Google SDK auto-instrumentation Jul 29, 2026
Add Anthropic and Google guides alongside expanded OpenAI coverage.
Document provider selection, content capture, exporter options, and lifecycle.
Clarify tracing navigation and integration discovery.
Document supported Boto3 Bedrock Runtime operations and setup.

Clarify content capture, streaming, and Botocore-wide tracing behavior.

Link the guide from observability navigation and Python SDK entry points.
@rite2hhh rite2hhh changed the title docs: document OpenAI, Anthropic, and Google SDK auto-instrumentation docs: document provider SDK auto-instrumentation Aug 4, 2026
@rite2hhh
rite2hhh merged commit c46ade8 into master Aug 4, 2026
4 checks passed
@rite2hhh
rite2hhh deleted the docs/openai-sdk-auto-instrumentation branch August 4, 2026 16:28
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