feat: Add OpenTelemetry integration design proposal #597
Conversation
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
JAORMX
force-pushed
the
feat/otel-integration-proposal
branch
from
6fabc17 to
2ef2ba2
Compare
| Environment variable support: | ||
| ```bash | ||
| TOOLHIVE_OTEL_ENABLED=true | ||
| TOOLHIVE_OTEL_ENDPOINT=https://api.honeycomb.io |
There was a problem hiding this comment.
Right! that's the idea; or a command line flag for this would be good too.
This proposal outlines a comprehensive approach to add OpenTelemetry observability to ToolHive's MCP server proxies through middleware-based instrumentation. Key features: - Leverages existing middleware system for clean integration - Supports both SSE and stdio transport modes - Provides traces, metrics, and structured logging - Includes MCP-specific instrumentation beyond HTTP metrics - Supports multiple OTEL backends and Prometheus integration - Maintains backward compatibility with zero performance regression The design includes detailed examples of traces and metrics for tools/call operations, showing rich observability into MCP protocol interactions. Related-to: #474 Signed-off-by: Juan Antonio Osorio <[email protected]>
JAORMX
force-pushed
the
feat/otel-integration-proposal
branch
from
2ef2ba2 to
19f3ec4
Compare
JAORMX
added a commit
that referenced
this pull request
Jun 10, 2025
- Add complete OpenTelemetry instrumentation with OTLP and Prometheus exporters - Implement HTTP middleware with MCP protocol-aware tracing and metrics - Add CLI flags for telemetry configuration (--otel-endpoint, --otel-metrics-port, etc.) - Expose /metrics endpoints on both HTTPSSEProxy and TransparentProxy - Include comprehensive observability documentation - Support dual export architecture (OTLP push + Prometheus pull) - Add tool-specific metrics and argument sanitization for security - Integrate seamlessly with existing middleware chain Implements: #597 Fixes: #474
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.
This proposal outlines a comprehensive approach to add OpenTelemetry observability to ToolHive's MCP server proxies through middleware-based instrumentation.
Key Features
What's Included
The design follows KISS and DRY principles by leveraging existing patterns and infrastructure, making it maintainable and extensible for future observability needs.
Related-to: #474