Skip to content

docs(v4): document experiment instrumentation migration - #3477

Merged
marliessophie merged 1 commit into
mainfrom
codex/v4-experiment-instrumentation-migration
Aug 6, 2026
Merged

docs(v4): document experiment instrumentation migration#3477
marliessophie merged 1 commit into
mainfrom
codex/v4-experiment-instrumentation-migration

Conversation

@marliessophie

@marliessophie marliessophie commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Add a dedicated experiment instrumentation subsection to the v3 → v4 migration guide.
  • Direct Python and JS/TS users to the Experiment Runner SDK.
  • Direct other languages and API integrations to OTEL traces with the experiment attribute propagation guide.
  • Explicitly explain that new use of POST /api/public/dataset-run-items is not part of the v4 write path.

Verification

  • pnpm run format:check
  • pnpm exec node scripts/check-h1-headings.js

Greptile Summary

The PR expands the v3-to-v4 migration guide with dedicated experiment-instrumentation guidance.

  • Directs Python and JS/TS users to the Experiment Runner SDK.
  • Directs other integrations to one OTEL trace per experiment item and the attribute-propagation guide.
  • Clarifies that POST /api/public/dataset-run-items is retained only for legacy compatibility.

Confidence Score: 5/5

The documentation-only change appears safe to merge, with no concrete broken links, rendering problems, or inaccurate migration instructions identified.

The new internal routes and explicit anchors exist, the heading syntax follows established repository conventions, and the migration instructions agree with the detailed SDK and OpenTelemetry experiment documentation.

Reviews (1): Last reviewed commit: "docs(v4): document experiment instrument..." | Re-trigger Greptile

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Aug 6, 2026
@vercel

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
langfuse-docs Ready Ready Preview Aug 6, 2026 2:01pm

Request Review

@dosubot dosubot Bot added the docs label Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

@claude review

@claude claude 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.

LGTM — small, well-scoped docs addition.

Extended reasoning...

Overview

The PR adds one new subsection ("Experiment instrumentation") to the v3→v4 self-hosting migration guide, plus a one-line clarification in the existing API table that POST /api/public/dataset-run-items is not part of the v4 write path. Only one file is touched, and the change is purely documentation prose — no code, config, or schema changes.

Security risks

None. This is static documentation content with no executable code, secrets, or user input handling.

Level of scrutiny

Low. This is a docs-only, additive change to a migration guide, following the same structure and heading conventions (H2/H3 with explicit [#anchor] tags) already used throughout the file.

Other factors

Verified both new links resolve: /docs/evaluation/experiments/experiments-via-sdk exists as a real page, and the OTEL anchor #experiments-ingesting-experiment-spans is explicitly defined via [#experiments-ingesting-experiment-spans] on the corresponding heading in content/integrations/native/opentelemetry/index.mdx. The file has exactly one H1 and only one H2/H3 level structure is used correctly, so it passes the H1 and heading-order checks. No md-override file exists for this route, so there is nothing to keep in sync. Content is consistent with the rest of the guide's tone and accurately reflects that the SDK-write path (dataset-run-items) is deprecated in favor of OTEL traces / the Experiment Runner SDK.

@marliessophie
marliessophie added this pull request to the merge queue Aug 6, 2026
@dosubot dosubot Bot added the auto-merge This PR is set to be merged label Aug 6, 2026
Merged via the queue into main with commit 27ef1f6 Aug 6, 2026
18 checks passed
@marliessophie
marliessophie deleted the codex/v4-experiment-instrumentation-migration branch August 6, 2026 14:54
@dosubot dosubot Bot removed the auto-merge This PR is set to be merged label Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant