Skip to content

fix: improve otel fanout docs discoverability [closes DOC-796]#2924

Merged
Kathryn May (katmayb) merged 4 commits intomainfrom
open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36
Mar 24, 2026
Merged

fix: improve otel fanout docs discoverability [closes DOC-796]#2924
Kathryn May (katmayb) merged 4 commits intomainfrom
open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36

Conversation

@katmayb
Copy link
Copy Markdown
Contributor

Description

This updates the OpenTelemetry tracing documentation so users can discover the recommended OTEL fanout approach via search and understand when to use it versus the collector telemetry guide.

Changes made:

  • Added SEO/frontmatter description to langsmith/trace-with-opentelemetry that explicitly includes LANGSMITH_OTEL_ENABLED and OTEL fanout terminology.
  • Added explicit body copy near the top of the page mentioning OTEL fanout and LANGSMITH_OTEL_ENABLED to improve on-page search relevance.
  • Renamed the advanced section heading to use fanout wording and added guidance clarifying:
    • use LANGSMITH_OTEL_ENABLED=true for application tracing fanout
    • use langsmith-collector for self-hosted LangSmith platform infrastructure telemetry

Resolves DOC-796.

Test Plan

  • Confirm /langsmith/trace-with-opentelemetry includes searchable terms: OTEL fanout and LANGSMITH_OTEL_ENABLED.
  • Verify the page now explains when to use OTEL fanout vs /langsmith/langsmith-collector.
  • Run make format and make lint (currently blocked by existing repository-wide lint failures unrelated to these doc changes).

… LANGSMITH_OTEL_ENABLED path instead of collector-only guidance.
@github-actions github-actions bot added langsmith For docs changes to LangSmith internal labels Mar 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 4, 2026

Mintlify preview ID generated: preview-opensw-1772657813-a6adfcf

Comment thread src/langsmith/trace-with-opentelemetry.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 9, 2026

Mintlify preview ID generated: preview-opensw-1773059896-eb68658

Comment thread src/langsmith/trace-with-opentelemetry.mdx Outdated
@katmayb Kathryn May (katmayb) marked this pull request as ready for review March 24, 2026 17:37
@github-actions
Copy link
Copy Markdown
Contributor

❌ docs.json validation failed

This PR has issues with docs.json: either pages were removed without redirects, or some pages reference non-existent source files.

 The following pages were removed from docs.json without adding redirects:
  - oss/javascript/langchain/test
  - oss/python/langchain/test

Please add a redirect for each removed page to the `redirects` array in docs.json.
Example: {"source": "/path/to/removed-page", "destination": "/path/to/new-location"}

@github-actions
Copy link
Copy Markdown
Contributor

Mintlify preview ID generated: preview-opensw-1774373921-cc4af9f

@github-actions
Copy link
Copy Markdown
Contributor

Mintlify preview ID generated: preview-opensw-1774374168-f584c25

@katmayb Kathryn May (katmayb) merged commit ba7b82b into main Mar 24, 2026
19 checks passed
@katmayb Kathryn May (katmayb) deleted the open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36 branch March 24, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants