Update OTel docs to match current implementation#584
Open
ChrisJBurns wants to merge 2 commits intomainfrom
Open
Update OTel docs to match current implementation#584ChrisJBurns wants to merge 2 commits intomainfrom
ChrisJBurns wants to merge 2 commits intomainfrom
Conversation
Update observability documentation to reflect the current ToolHive OpenTelemetry implementation, including new semantic convention attribute names, vMCP metrics, trace context propagation, and the legacy attributes compatibility flag. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates ToolHive observability documentation to align with the current OpenTelemetry attribute/metric naming scheme, and expands vMCP telemetry guidance so users can more easily interpret traces and metrics across ToolHive and vMCP deployments.
Changes:
- Updated trace attribute examples to use newer OTel semantic convention attribute names (HTTP/MCP/GenAI).
- Added vMCP-specific metrics sections (backend/workflow/optimizer) and expanded distributed tracing details.
- Updated CLI telemetry docs to include
--otel-use-legacy-attributesand corrected the documented default service name.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/toolhive/guides-vmcp/telemetry-and-metrics.mdx | Adds vMCP metric inventories and tracing span naming/attributes; updates sampling example. |
| docs/toolhive/guides-cli/telemetry-and-metrics.mdx | Documents default service name, adds --otel-use-legacy-attributes flag to usage + table. |
| docs/toolhive/concepts/observability.mdx | Refreshes trace/attribute examples, adds MCP semantic-convention metrics + trace context propagation section. |
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
http.request.method,mcp.method.name,gen_ai.tool.name, etc.) instead of legacy names--otel-use-legacy-attributesflag to CLI telemetry guide and fix default service namemcp.server.operation.duration,mcp.client.operation.duration) and trace context propagation section to concepts pageTest plan
pkg/telemetry/pkg/vmcp/server/telemetry.go🤖 Generated with Claude Code