docs: align OTel guidance with Agent Host architecture - #335175
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
There are a couple of concrete documentation issues in src/vs/platform/agentHost/OTEL.md (table rendering and exporterType wording) that should be corrected before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review tier: Lite
Findings: 2
New issues introduced by this change (2)
| Severity | Finding |
|---|---|
 |
src/vs/platform/agentHost/OTEL.md — The chat.agentHost.otel.exporterType description is a bit ambiguous about what happens when… |
|
src/vs/platform/agentHost/OTEL.md — The OTEL_EXPORTER_OTLP_HEADERS row has an unbalanced backtick in the example… |
What changed in this PR
Updates VS Code’s OpenTelemetry documentation to reflect the current Agent Host-based architecture, clarifying ownership boundaries between Agent Host sessions and the local Copilot Chat extension pipeline, and removing deprecated Copilot CLI bridge documentation/diagrams.
Changes:
- Repositions
src/vs/platform/agentHost/OTEL.mdas the primary Agent Host OTel architecture/integration reference (including sources-of-truth guidance and a Mermaid flow diagram). - Scopes
extensions/copilot/docs/monitoring/agent_monitoring.mdto the local Copilot Chat extension-host pipeline and updates configuration guidance accordingly. - Removes obsolete monitoring architecture and HTML flow-diagram docs, and updates the OTel skill guidance to match current ownership/version-auditing practices.
| File | Description |
|---|---|
| src/vs/platform/agentHost/OTEL.md | Establishes Agent Host OTel as the canonical architecture/integration doc; updates routing description, settings/env guidance, and diagrams. |
| extensions/copilot/docs/monitoring/agent_monitoring.md | Refocuses the doc on local Copilot Chat telemetry and updates content-capture/auth header guidance. |
| extensions/copilot/docs/monitoring/agent_monitoring_arch.md | Removes deprecated extension-host architecture guide. |
| extensions/copilot/docs/monitoring/otel-data-flow.html | Removes deprecated standalone HTML data-flow diagram. |
| .github/skills/otel/SKILL.md | Updates repository guidance (“otel” skill) to align with Agent Host ownership and runtime version discipline. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Zhichao Li (zhichli)
marked this pull request as ready for review
September 9, 2026 00:15
Zhichao Li (zhichli)
force-pushed
the
docs/agent-host-otel-guidance
branch
from
September 9, 2026 00:21
1a01462 to
751c53b
Compare
Joaquín Ruales (jruales)
approved these changes
Sep 9, 2026
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.
Summary
src/vs/platform/agentHost/OTEL.mdthe architecture and integration reference for current Agent Host telemetryValidation
git diff --checkpackage-lock.jsonThe pre-commit hook could not run because the local checkout is missing
@vscode/gulp-vinyl-zip; this is a documentation-only change.