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

Closed
opened 2026-06-05 18:20:44 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/2924
Author: @katmayb
Created: 3/4/2026
Status: Merged
Merged: 3/24/2026
Merged by: @katmayb

Base: mainHead: open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36


📝 Commits (4)

  • 8892414 Improve OTEL fanout doc discoverability so users find the recommended LANGSMITH_OTEL_ENABLED path instead of collector-only guidance.
  • 3d6277a Apply suggestion from @katmayb
  • 9dd78c7 Apply suggestion from @katmayb
  • a6724d1 Merge branch 'main' into open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36

📊 Changes

1 file changed (+6 additions, -0 deletions)

View changed files

📝 src/langsmith/trace-with-opentelemetry.mdx (+6 -0)

📄 Description

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).

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/2924 **Author:** [@katmayb](https://github.com/katmayb) **Created:** 3/4/2026 **Status:** ✅ Merged **Merged:** 3/24/2026 **Merged by:** [@katmayb](https://github.com/katmayb) **Base:** `main` ← **Head:** `open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36` --- ### 📝 Commits (4) - [`8892414`](https://github.com/langchain-ai/docs/commit/8892414dcde32422b3f6d1b58b8162aeecc737b8) Improve OTEL fanout doc discoverability so users find the recommended LANGSMITH_OTEL_ENABLED path instead of collector-only guidance. - [`3d6277a`](https://github.com/langchain-ai/docs/commit/3d6277a9c897283b64e7f0a15af27a8e2fde916a) Apply suggestion from @katmayb - [`9dd78c7`](https://github.com/langchain-ai/docs/commit/9dd78c74577a583894029a1c14bf3da481ecae10) Apply suggestion from @katmayb - [`a6724d1`](https://github.com/langchain-ai/docs/commit/a6724d13783f73e38eeb4d6ba2fd22b7be31f7bf) Merge branch 'main' into open-swe/0662749c-1c45-0c29-c067-a0dd15a8ff36 ### 📊 Changes **1 file changed** (+6 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `src/langsmith/trace-with-opentelemetry.mdx` (+6 -0) </details> ### 📄 Description ## 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). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:20:44 -04:00
yindo closed this issue 2026-06-05 18:20:47 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#3008