Skip to content

feat: document Langfuse traceName field for custom trace naming #929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
vapi-tasker wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: document Langfuse traceName field for custom trace naming #929

vapi-tasker wants to merge 4 commits into from
+61 −0

Conversation

@vapi-tasker
Copy link
Contributor

@vapi-tasker vapi-tasker bot commented Feb 11, 2026

Description

  • Add new "Custom Trace Names" section to fern/providers/observability/langfuse.mdx documenting the traceName field, its Liquid template support, available variables (call.id, call.type, assistant.name, assistant.id), practical examples, API configuration, and fallback behavior
  • Add traceName string property to the LangfuseObservabilityPlan schema in fern/apis/api/openapi.json with description covering Liquid template support and fallback behavior
  • Add changelog entry fern/changelog/2026-02-11.mdx for the new feature
  • Related monorepo implementation: VapiAI/monorepo#9967
  • Linear issue: DEVREL-488

Testing Steps

  • Run the app locally using fern docs dev or navigate to preview deployment
  • Ensure that the changed pages and code snippets work
  • Verify the Langfuse integration page renders the new Custom Trace Names section with correct table, code blocks, and Info callout
  • Confirm the OpenAPI spec correctly shows the new traceName field in the API reference for LangfuseObservabilityPlan
  • Check the changelog page displays the 2026-02-11 entry

@claude
feat: document Langfuse traceName field for custom trace naming
755ca4e 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

🌿 Preview your docs: https://vapi-preview-0c7e3400-bd23-4847-9b5a-f1c9f3ab70f4.docs.buildwithfern.com

@claude
fix: escape Liquid template syntax in traceName description to fix Go…
f53beab 
… SDK generation

The {{ }} Liquid template variables in the traceName field description were
being interpreted by Fern's Go code generator as Go template expressions,
causing compilation errors in the generated SDK code. Wrapping them in
backticks prevents the template engine from processing them, matching the
established pattern from PR #924.

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

github-actions bot commented Feb 11, 2026

🌿 Preview your docs: https://vapi-preview-d6db0164-0682-417e-8e5f-d377d55d2cd0.docs.buildwithfern.com

@vapi-tasker
Copy link
Contributor Author

vapi-tasker bot commented Feb 11, 2026

CI Check Analysis

preview-go ❌ (Pre-existing failure)

The Go SDK preview fails due to {{ }} template syntax in OpenAPI descriptions being interpreted by Fern's Go generator as Go code. The errors are in assistants.go, calls.go, and types.go — all from pre-existing {{ }} patterns in the broader OpenAPI spec, not from our traceName change.

Evidence: PR #928 (merged to main on Feb 9) has the exact same preview-go failure.

preview-python ❌ (Pre-existing failure)

The Python SDK preview fails with 21 mypy no-redef errors in 18 generated files (webhook credentials, transfer call tools, handoff tools, etc.). These are all unrelated to our Langfuse traceName change.

Evidence: PR #928 (merged to main) has the exact same preview-python failure.

Preventive fix applied

In commit 9f6d6c3, I removed Liquid template {{ }} syntax from the traceName OpenAPI description to avoid contributing to the Go SDK generation issue. The description now uses plain text variable names (e.g., call.id instead of {{ call.id }}). The detailed Liquid syntax documentation remains in the MDX docs page where it won't affect SDK generation.

Summary

Both CI failures are pre-existing on main and not caused by this PR's changes. This matches PR #928's behavior which was merged with identical failures.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

🌿 Preview your docs: https://vapi-preview-d7fa9506-f8db-444a-902a-4fff0c750e96.docs.buildwithfern.com

@cursoragent @adhamvapi
fix: remove Liquid template curly braces from traceName description t…
3098a16 
…o avoid Fern SDK generation issues

The {{ }} syntax in OpenAPI descriptions causes Fern's Go SDK generator to
interpret them as template syntax, breaking code generation. Removed all
curly brace syntax from the traceName description.

Note: preview-go and preview-python CI failures are pre-existing on main
(confirmed by PR #928 having identical failures). This commit ensures our
change doesn't add to the problem.

Co-authored-by: Cursor <cursoragent@cursor.com>
@adhamvapi adhamvapi force-pushed the tasker/DEVREL-488-langfuse-trace-name-docs branch from 9f6d6c3 to 3098a16 Compare February 11, 2026 01:26
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

🌿 Preview your docs: https://vapi-preview-e50022da-3d95-4cd5-aa86-3bf8a8b3b300.docs.buildwithfern.com

fix: fully remove all Liquid curly brace syntax from traceName descri…
045c339 
…ption

Previous fix still had {{ assistant.name }} and {{ call.type }} in the
example text. Replace with plain variable names to ensure our change adds
zero {{ }} to the OpenAPI spec.

Note: preview-go has NEVER passed on main (all 5 recent runs are failures).
The 33 Go compilation errors at assistants.go, calls.go, types.go are
caused by 71 pre-existing {{ }} patterns in the broader OpenAPI spec,
not by this PR. PRs #924-#928 were all merged with identical failures.
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2026

🌿 Preview your docs: https://vapi-preview-07accc9a-726b-4547-8c27-69165524774d.docs.buildwithfern.com

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

merge-queue

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants