Repository navigation
PAL-1104 document Langfuse server version detection and SDK v5 routing - #1351
Open
peter-vapi wants to merge 5 commits into
Open
peter-vapi wants to merge 5 commits into
peter-vapi wants to merge 5 commits into
Conversation
…oubleshooting for redirecting host urls and tracing failures OpenCode session ID: ses_ece821fbeffeZ6yysKJ60XiP1X
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a15b9e-5474-76c9-8e24-dc72732175d9.docs.buildwithfern.com |
The dashboard integration modal now links to this page instead of going straight to Langfuse's docs, so readers need a path to Langfuse's own tracing guide once they land here. - Add a reference to Langfuse's tracing documentation right after Vapi's framing paragraph, before the video walkthrough OpenCode session ID: ses_ece821fbeffeZ6yysKJ60XiP1X
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a1605b-2ef6-734e-9dd5-b19e95003ad4.docs.buildwithfern.com |
peter-vapi
marked this pull request as ready for review
October 22, 2026 21:05
peter-vapi
requested review from
a team and
ashwin-vapi
and removed request for
a team
October 22, 2026 21:05
hal-anil-vapi
requested changes
Oct 28, 2026
- Note that each top-level metadata key maps to one trace attribute, with nested values serialized as JSON strings - Document the 512-key cap per trace and that excess keys beyond the first 512 are silently dropped - Clarify that Vapi's own identifiers (e.g. call ID) are added separately and always kept, even if user metadata reuses the same key name - Recommend keeping metadata small and filterable, storing large payloads elsewhere by reference Addresses reviewer feedback on vapi#23001 OpenCode session ID: ses_ece821fbeffeZ6yysKJ60XiP1X
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a189cb-0fe3-724d-8447-da11ea5449e0.docs.buildwithfern.com |
Address Hal's four review comments on the Langfuse docs PR and move the credentials screenshot to self-hosted storage. - Describe the credential walkthrough in full: automatic version read on Host URL blur, the Check server version trigger, the save gate, the manual-entry fallback for proxied health endpoints, and the public-address requirement for the Host URL - Rewrite the routing section into four explicit cases, with Langfuse Cloud recognized by hostname regardless of when the credential was saved; note that a versionless self-hosted credential stays on the legacy path until re-saved, and remove the false claim that a later probe corrects the stored version automatically - Add a Trace IDs and Call Correlation section documenting the sha256-derived trace ID, metadata.callId as the recommended correlation key, and TypeScript/Python derivation snippets - Expand Troubleshooting to four entries covering every refusal the save path can return - Add the Langfuse Cloud legacy-API/evaluator cutoff of November 16, 2026, with a pointer to the LLM-as-a-judge migration guide - Host the credentials screenshot under fern/static/images/providers instead of hotlinking from langfuse.com, and update it to show the Server version row OpenCode session ID: ses_e4d07141affeH93cc94qFsDEgV
- Pulls in main's broader alt-text pass (#1365) and other unrelated doc fixes (SIP dashboard nav copy, OpenAPI spec updates, traffic allocation GA, Vapi for CX renaming) that had landed since this branch was cut - Resolves the only conflict, on the credentials Frame in the Langfuse integration doc: main edited caption/alt text on the same two lines this branch rewrote to self-host the screenshot - Keeps both sides: this branch's local image path, plus main's caption and alt text, extending the alt text to describe the Server version row and Check server version button now visible in the new screenshot - Leaves the example-trace Frame on main's version, unchanged by this branch - fern check passes with no warnings on this page, clearing CI to schedule the PR OpenCode session ID: ses_e4d07141affeH93cc94qFsDEgV
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a1b385-ca9e-72db-92ba-14d8272cddbc.docs.buildwithfern.com |
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
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.
Tracking: PAL-1288 Publish new docs gates the merge of this PR. Parent: PAL-1104 Migrate Langfuse tracing to JS SDK v5.
Documents the Langfuse integration upgrade on the existing Langfuse observability page.
What the page now covers
Check server versiontrigger, save gating until a version resolves, the manual-entry fallback when/api/public/healthis hidden, and the public-address requirement.sha256(callId);metadata.callIdis the recommended correlation key; a warning plus TypeScript/Python snippets for anyone whose code joins ontraceId == call.id.Accompanies VapiAI/vapi#25539 (groundwork), VapiAI/vapi#25583 (version detection) and VapiAI/vapi#25581 (v5 OTLP tracing client), all merged, plus VapiAI/vapi#25708 (version-aware validation and the error taxonomy these troubleshooting entries quote). Supersedes the reference to the original VapiAI/vapi#23001, which was closed and split into those PRs. Shared with the Langfuse team in #ext-vapi-langfuse.
Before merge
https://langfuse.com/images/docs/vapi-integration-credentials.png, hosted by Langfuse) with a fresh capture of the Langfuse card showing the Server version row, and host it underfern/static/images/providers/so we own the asset.After the November 16, 2026 cutoff